From cb1759399a23f3c0503df9414495eb6543c827b7 Mon Sep 17 00:00:00 2001 From: Anuj Sharma Date: Mon, 17 Aug 2026 11:40:43 +0530 Subject: [PATCH 1/4] feat: added 999 cancellation reason code & updated structure --- api/build/build.yaml | 130 +++++++++++------- .../docs/changeLog/TRV10_2.1.0_030924.md | 14 ++ api/components/enum/default/index.yaml | 100 +++++++------- ..._ride_with_confirm_cancel_status___X5.yaml | 6 +- ...g_a_ride_with_soft_cancel_status___X4.yaml | 6 +- .../cancel/cancel_request_confirm_cancel.yaml | 6 +- .../cancel/cancel_request_soft_cancel.yaml | 6 +- ui/build.js | 2 +- 8 files changed, 167 insertions(+), 103 deletions(-) diff --git a/api/build/build.yaml b/api/build/build.yaml index 47286d07..c5efac5b 100644 --- a/api/build/build.yaml +++ b/api/build/build.yaml @@ -282,6 +282,10 @@ paths: $ref: '#/components/schemas/Option/properties/id' descriptor: $ref: '#/components/schemas/Descriptor' + cancellation: + description: The cancellation details of this order + allOf: + - $ref: '#/components/schemas/Cancellation' required: - order_id required: @@ -3237,54 +3241,64 @@ x-enum: location: *ref_0 domain: *ref_1 message: - cancellation_reason_id: &ref_10 - - code: '000' - description: >- - Technical cancellation of orders in case protocol technical - failures(BAP/BPP) - reference: - + Technical cancellation of orders in case protocol technical + failures(BAP/BPP) + reference: - + Seller app cannot confirm the ride as no drivers are + available(BPP) + reference: - + Describes the cancellation reason as "Others" when none of the + predefined cancellation reasons apply. + reference:
Format:

Authorization : Signature keyId=\"{subscriber_id}|{unique_key_id}|{algorithm}\",algorithm=\"ed25519\",created=\"1606970629\",expires=\"1607030629\",headers=\"(created) (expires) digest\",signature=\"Base64(signing string)\""}},"schemas":{"Ack":{"description":"Describes the acknowledgement sent in response to an API call. If the implementation uses HTTP/S, then Ack must be returned in the same session. Every API call to a BPP must be responded to with an Ack whether the BPP intends to respond with a callback or not. This has one property called `status` that indicates the status of the Acknowledgement.","type":"object","additionalProperties":false,"properties":{"status":{"type":"string","description":"The status of the acknowledgement. If the request passes the validation criteria of the BPP, then this is set to ACK. If a BPP responds with status = `ACK` to a request, it is required to respond with a callback. If the request fails the validation criteria, then this is set to NACK. Additionally, if a BPP does not intend to respond with a callback even after the request meets the validation criteria, it should set this value to `NACK`.","enum":["ACK","NACK"]},"tags":{"description":"A list of tags containing any additional information sent along with the Acknowledgement.","type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"AddOn":{"description":"Describes an additional item offered as a value-addition to a product or service. This does not exist independently in a catalog and is always associated with an item.","type":"object","additionalProperties":false,"properties":{"id":{"description":"Provider-defined ID of the add-on","type":"string"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"price":{"$ref":"#/components/schemas/Price"},"quantity":{"$ref":"#/components/schemas/ItemQuantity"}}},"Address":{"description":"Describes a postal address.","type":"string"},"Agent":{"description":"Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the BPP wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.","type":"object","additionalProperties":false,"properties":{"person":{"$ref":"#/components/schemas/Person"},"contact":{"$ref":"#/components/schemas/Contact"},"organization":{"$ref":"#/components/schemas/Organization"},"rating":{"$ref":"#/components/schemas/Rating/properties/value"}}},"Authorization":{"description":"Describes an authorization mechanism used to start or end the fulfillment of an order. For example, in the mobility sector, the driver may require a one-time password to initiate the ride. In the healthcare sector, a patient may need to provide a password to open a video conference link during a teleconsultation.","type":"object","additionalProperties":false,"properties":{"type":{"description":"Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy.","type":"string"},"token":{"description":"Token used for authorization. This is typically generated at the BPP. The BAP can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering.","type":"string"},"valid_from":{"description":"Timestamp in RFC3339 format from which token is valid","type":"string","format":"date-time"},"valid_to":{"description":"Timestamp in RFC3339 format until which token is valid","type":"string","format":"date-time"},"status":{"description":"Status of the token","type":"string"}}},"Billing":{"description":"Describes the billing details of an entity.
This has properties like name,organization,address,email,phone,time,tax_number, created_at,updated_at","type":"object","additionalProperties":false,"properties":{"name":{"description":"Name of the billable entity","type":"string"},"organization":{"description":"Details of the organization being billed.","allOf":[{"$ref":"#/components/schemas/Organization"}]},"address":{"description":"The address of the billable entity","allOf":[{"$ref":"#/components/schemas/Address"}]},"state":{"description":"The state where the billable entity resides. This is important for state-level tax calculation","allOf":[{"$ref":"#/components/schemas/State"}]},"city":{"description":"The city where the billable entity resides.","allOf":[{"$ref":"#/components/schemas/City"}]},"email":{"description":"Email address where the bill is sent to","type":"string","format":"email"},"phone":{"description":"Phone number of the billable entity","type":"string"},"time":{"description":"Details regarding the billing period","allOf":[{"$ref":"#/components/schemas/Time"}]},"tax_id":{"description":"ID of the billable entity as recognized by the taxation authority","type":"string"}}},"Cancellation":{"description":"Describes a cancellation event","type":"object","additionalProperties":false,"properties":{"time":{"description":"Date-time when the order was cancelled by the buyer","type":"string","format":"date-time"},"cancelled_by":{"type":"string","enum":["CONSUMER","PROVIDER"]},"reason":{"description":"The reason for cancellation","allOf":[{"$ref":"#/components/schemas/Option"}]},"additional_description":{"description":"Any additional information regarding the nature of cancellation","allOf":[{"$ref":"#/components/schemas/Descriptor"}]}}},"CancellationTerm":{"description":"Describes the cancellation terms of an item or an order. This can be referenced at an item or order level. Item-level cancellation terms can override the terms at the order level.","type":"object","additionalProperties":false,"properties":{"fulfillment_state":{"description":"The state of fulfillment during which this term is applicable.","allOf":[{"$ref":"#/components/schemas/FulfillmentState"}]},"reason_required":{"description":"Indicates whether a reason is required to cancel the order","type":"boolean"},"cancel_by":{"description":"Information related to the time of cancellation.","allOf":[{"$ref":"#/components/schemas/Time"}]},"cancellation_fee":{"$ref":"#/components/schemas/Fee"},"xinput":{"$ref":"#/components/schemas/XInput"},"external_ref":{"$ref":"#/components/schemas/MediaFile"},"cancellation_eligible":{"description":"Indicates if cancellation is eligible","type":"boolean"}}},"Catalog":{"description":"Describes the products or services offered by a BPP. This is typically sent as the response to a search intent from a BAP. The payment terms, offers and terms of fulfillment supported by the BPP can also be included here. The BPP can show hierarchical nature of products/services in its catalog using the parent_category_id in categories. The BPP can also send a ttl (time to live) in the context which is the duration for which a BAP can cache the catalog and use the cached catalog.
This has properties like bbp/descriptor,bbp/categories,bbp/fulfillments,bbp/payments,bbp/offers,bbp/providers and exp
This is used in the following situations.
  • This is typically used in the discovery stage when the BPP sends the details of the products and services it offers as response to a search intent from the BAP.
","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"fulfillments":{"description":"Fulfillment modes offered at the BPP level. This is used when a BPP itself offers fulfillments on behalf of the providers it has onboarded.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment"}},"payments":{"description":"Payment terms offered by the BPP for all transactions. This can be overriden at the provider level.","type":"array","items":{"$ref":"#/components/schemas/Payment"}},"offers":{"description":"Offers at the BPP-level. This is common across all providers onboarded by the BPP.","type":"array","items":{"$ref":"#/components/schemas/Offer"}},"providers":{"type":"array","items":{"$ref":"#/components/schemas/Provider"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}},"exp":{"description":"Timestamp after which catalog will expire","type":"string","format":"date-time"},"ttl":{"description":"Duration in seconds after which this catalog will expire","type":"string"}}},"Category":{"description":"A label under which a collection of items can be grouped.","type":"object","additionalProperties":false,"properties":{"id":{"description":"ID of the category","type":"string"},"parent_category_id":{"$ref":"#/components/schemas/Category/properties/id"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"time":{"$ref":"#/components/schemas/Time"},"ttl":{"description":"Time to live for an instance of this schema"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"Circle":{"description":"Describes a circular region of a specified radius centered at a specified GPS coordinate.","type":"object","additionalProperties":false,"properties":{"gps":{"$ref":"#/components/schemas/Gps"},"radius":{"$ref":"#/components/schemas/Scalar"}}},"City":{"description":"Describes a city","type":"object","additionalProperties":false,"properties":{"name":{"description":"Name of the city","type":"string"},"code":{"description":"City code","type":"string"}}},"Contact":{"description":"Describes the contact information of an entity","type":"object","additionalProperties":false,"properties":{"phone":{"type":"string"},"email":{"type":"string"},"jcard":{"type":"object","additionalProperties":false,"description":"A Jcard object as per draft-ietf-jcardcal-jcard-03 specification"}}},"Context":{"description":"Every API call in beckn protocol has a context. It provides a high-level overview to the receiver about the nature of the intended transaction. Typically, it is the BAP that sets the transaction context based on the consumer's location and action on their UI. But sometimes, during unsolicited callbacks, the BPP also sets the transaction context but it is usually the same as the context of a previous full-cycle, request-callback interaction between the BAP and the BPP. The context object contains four types of fields.
  1. Demographic information about the transaction using fields like `domain`, `country`, and `region`.
  2. Addressing details like the sending and receiving platform's ID and API URL.
  3. Interoperability information like the protocol version that implemented by the sender and,
  4. Transaction details like the method being called at the receiver's endpoint, the transaction_id that represents an end-to-end user session at the BAP, a message ID to pair requests with callbacks, a timestamp to capture sending times, a ttl to specifiy the validity of the request, and a key to encrypt information if necessary.
This object must be passed in every interaction between a BAP and a BPP. In HTTP/S implementations, it is not necessary to send the context during the synchronous response. However, in asynchronous protocols, the context must be sent during all interactions,","type":"object","additionalProperties":false,"properties":{"domain":{"description":"Domain code that is relevant to this transaction context","allOf":[{"$ref":"#/components/schemas/Domain/properties/code","type":"string"}]},"location":{"description":"The location where the transaction is intended to be fulfilled.","allOf":[{"$ref":"#/components/schemas/Location"}]},"action":{"description":"The Beckn protocol method being called by the sender and executed at the receiver.","type":"string"},"version":{"type":"string","description":"Version of transaction protocol being used by the sender."},"bap_id":{"description":"Subscriber ID of the BAP","allOf":[{"description":"A globally unique identifier of the platform, Typically it is the fully qualified domain name (FQDN) of the platform.","type":"string"}]},"bap_uri":{"description":"Subscriber URL of the BAP for accepting callbacks from BPPs.","allOf":[{"description":"The callback URL of the Subscriber. This should necessarily contain the same domain name as set in `subscriber_id``.","type":"string","format":"uri"}]},"bpp_id":{"description":"Subscriber ID of the BPP","allOf":[{"$ref":"#/components/schemas/Context/properties/bap_id/allOf/0"}]},"bpp_uri":{"description":"Subscriber URL of the BPP for accepting calls from BAPs.","allOf":[{"$ref":"#/components/schemas/Context/properties/bap_uri/allOf/0"}]},"transaction_id":{"description":"This is a unique value which persists across all API calls from `search` through `confirm`. This is done to indicate an active user session across multiple requests. The BPPs can use this value to push personalized recommendations, and dynamic offerings related to an ongoing transaction despite being unaware of the user active on the BAP.","type":"string","format":"uuid"},"message_id":{"description":"This is a unique value which persists during a request / callback cycle. Since beckn protocol APIs are asynchronous, BAPs need a common value to match an incoming callback from a BPP to an earlier call. This value can also be used to ignore duplicate messages coming from the BPP. It is recommended to generate a fresh message_id for every new interaction. When sending unsolicited callbacks, BPPs must generate a new message_id.","type":"string","format":"uuid"},"timestamp":{"description":"Time of request generation in RFC3339 format","type":"string","format":"date-time"},"key":{"description":"The encryption public key of the sender","type":"string"},"ttl":{"description":"The duration in ISO8601 format after timestamp for which this message holds valid","type":"string"}}},"Country":{"description":"Describes a country","type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the country"},"code":{"type":"string","description":"Country code as per ISO 3166-1 and ISO 3166-2 format"}}},"Credential":{"description":"Describes a credential of an entity - Person or Organization","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","default":"VerifiableCredential"},"url":{"description":"URL of the credential","type":"string","format":"uri"}}},"Customer":{"description":"Describes a customer buying/availing a product or a service","type":"object","additionalProperties":false,"properties":{"person":{"$ref":"#/components/schemas/Person"},"contact":{"$ref":"#/components/schemas/Contact"}}},"DecimalValue":{"description":"Describes a numerical value in decimal form","type":"string","pattern":"[+-]?([0-9]*[.])?[0-9]+"},"Descriptor":{"description":"Physical description of something.","type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"code":{"type":"string"},"short_desc":{"type":"string"},"long_desc":{"type":"string"},"additional_desc":{"type":"object","additionalProperties":false,"properties":{"url":{"type":"string"},"content_type":{"type":"string","enum":["text/plain","text/html","application/json"]}}},"media":{"type":"array","items":{"$ref":"#/components/schemas/MediaFile"}},"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"}}}},"Domain":{"description":"Described the industry sector or sub-sector. The network policy should contain codes for all the industry sectors supported by the network. Domains can be created in varying levels of granularity. The granularity of a domain can be decided by the participants of the network. Too broad domains will result in irrelevant search broadcast calls to BPPs that don't have services supporting the domain. Too narrow domains will result in a large number of registry entries for each BPP. It is recommended that network facilitators actively collaborate with various working groups and network participants to carefully choose domain codes keeping in mind relevance, performance, and opportunity cost. It is recommended that networks choose broad domains like mobility, logistics, healthcare etc, and progressively granularize them as and when the number of network participants for each domain grows large.","type":"object","additionalProperties":false,"properties":{"name":{"description":"Name of the domain","type":"string"},"code":{"description":"Standard code representing the domain. The standard is usually published as part of the network policy. Furthermore, the network facilitator should also provide a mechanism to provide the supported domains of a network."},"additional_info":{"description":"A url that contains addtional information about that domain.","allOf":[{"$ref":"#/components/schemas/MediaFile"}]}}},"Duration":{"description":"Describes duration as per ISO8601 format","type":"string"},"Error":{"description":"Describes an error object that is returned by a BAP, BPP or BG as a response or callback to an action by another network participant. This object is sent when any request received by a network participant is unacceptable. This object can be sent either during Ack or with the callback.","type":"object","additionalProperties":false,"properties":{"code":{"type":"string","description":"Standard error code. For full list of error codes, refer to docs/protocol-drafts/BECKN-005-ERROR-CODES-DRAFT-01.md of this repo\""},"paths":{"type":"string","description":"Path to json schema generating the error. Used only during json schema validation errors"},"message":{"type":"string","description":"Human readable message describing the error. Used mainly for logging. Not recommended to be shown to the user."}}},"Fee":{"description":"A fee applied on a particular entity","type":"object","additionalProperties":false,"properties":{"percentage":{"description":"Percentage of a value","allOf":[{"$ref":"#/components/schemas/DecimalValue"}]},"amount":{"description":"A fixed value","allOf":[{"$ref":"#/components/schemas/Price"}]}}},"Form":{"description":"Describes a form","type":"object","additionalProperties":false,"properties":{"id":{"description":"The form identifier.","type":"string"},"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.","type":"string","format":"uri"},"data":{"description":"The form submission data","type":"object","additionalProperties":true},"mime_type":{"description":"This field indicates the nature and format of the form received by querying the url. MIME types are defined and standardized in IETF's RFC 6838.","type":"string","enum":["text/html","application/html","application/xml","none"]},"resubmit":{"type":"boolean"},"multiple_submissions":{"type":"boolean"}}},"Fulfillment":{"description":"Describes how a an order will be rendered/fulfilled to the end-customer","type":"object","additionalProperties":false,"properties":{"id":{"description":"Unique reference ID to the fulfillment of an order","type":"string"},"type":{"description":"A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. For example, a retail order can be fulfilled either via store pickup or a home delivery. Similarly, a medical consultation can be provided either in-person or via tele-consultation. The network policy must publish standard fulfillment type codes for the different modes of fulfillment.","type":"string"},"rateable":{"description":"Whether the fulfillment can be rated or not","type":"boolean"},"rating":{"description":"The rating value of the fulfullment service.","allOf":[{"$ref":"#/components/schemas/Rating/properties/value"}]},"state":{"description":"The current state of fulfillment. The BPP must set this value whenever the state of the order fulfillment changes and fire an unsolicited `on_status` call.","allOf":[{"$ref":"#/components/schemas/FulfillmentState"}]},"tracking":{"type":"boolean","description":"Indicates whether the fulfillment allows tracking","default":false},"customer":{"description":"The person that will ultimately receive the order","allOf":[{"$ref":"#/components/schemas/Customer"}]},"agent":{"description":"The agent that is currently handling the fulfillment of the order","allOf":[{"$ref":"#/components/schemas/Agent"}]},"contact":{"$ref":"#/components/schemas/Contact"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"stops":{"description":"The list of logical stops encountered during the fulfillment of an order.","type":"array","items":{"$ref":"#/components/schemas/Stop"}},"path":{"description":"The physical path taken by the agent that can be rendered on a map. The allowed format of this property can be set by the network.","type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"FulfillmentState":{"description":"Describes the state of fulfillment","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string","description":"ID of entity which changed the state"}}},"Gps":{"description":"Describes a GPS coordinate","type":"string","pattern":"^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?),\\s*[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$"},"Image":{"description":"Describes an image","type":"object","additionalProperties":false,"properties":{"url":{"description":"URL to the image. This can be a data url or an remote url","type":"string","format":"uri"},"size_type":{"description":"The size of the image. The network policy can define the default dimensions of each type","type":"string","enum":["xs","sm","md","lg","xl","custom"]},"width":{"description":"Width of the image in pixels","type":"string"},"height":{"description":"Height of the image in pixels","type":"string"}}},"Intent":{"description":"The intent to buy or avail a product or a service. The BAP can declare the intent of the consumer containing
  • What they want (A product, service, offer)
  • Who they want (A seller, service provider, agent etc)
  • Where they want it and where they want it from
  • When they want it (start and end time of fulfillment
  • How they want to pay for it

This has properties like descriptor,provider,fulfillment,payment,category,offer,item,tags
This is typically used by the BAP to send the purpose of the user's search to the BPP. This will be used by the BPP to find products or services it offers that may match the user's intent.
For example, in Mobility, the mobility consumer declares a mobility intent. In this case, the mobility consumer declares information that describes various aspects of their journey like,
  • Where would they like to begin their journey (intent.fulfillment.start.location)
  • Where would they like to end their journey (intent.fulfillment.end.location)
  • When would they like to begin their journey (intent.fulfillment.start.time)
  • When would they like to end their journey (intent.fulfillment.end.time)
  • Who is the transport service provider they would like to avail services from (intent.provider)
  • Who is traveling (This is not recommended in public networks) (intent.fulfillment.customer)
  • What kind of fare product would they like to purchase (intent.item)
  • What add-on services would they like to avail
  • What offers would they like to apply on their booking (intent.offer)
  • What category of services would they like to avail (intent.category)
  • What additional luggage are they carrying
  • How would they like to pay for their journey (intent.payment)

For example, in health domain, a consumer declares the intent for a lab booking the describes various aspects of their booking like,
  • Where would they like to get their scan/test done (intent.fulfillment.start.location)
  • When would they like to get their scan/test done (intent.fulfillment.start.time)
  • When would they like to get the results of their test/scan (intent.fulfillment.end.time)
  • Who is the service provider they would like to avail services from (intent.provider)
  • Who is getting the test/scan (intent.fulfillment.customer)
  • What kind of test/scan would they like to purchase (intent.item)
  • What category of services would they like to avail (intent.category)
  • How would they like to pay for their journey (intent.payment)
","type":"object","additionalProperties":false,"properties":{"descriptor":{"description":"A raw description of the search intent. Free text search strings, raw audio, etc can be sent in this object.","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"provider":{"description":"The provider from which the customer wants to place to the order from","allOf":[{"$ref":"#/components/schemas/Provider"}]},"fulfillment":{"description":"Details on how the customer wants their order fulfilled","allOf":[{"$ref":"#/components/schemas/Fulfillment"}]},"payment":{"description":"Details on how the customer wants to pay for the order","allOf":[{"$ref":"#/components/schemas/Payment"}]},"category":{"description":"Details on the item category","allOf":[{"$ref":"#/components/schemas/Category"}]},"offer":{"description":"details on the offer the customer wants to avail","allOf":[{"$ref":"#/components/schemas/Offer"}]},"item":{"description":"Details of the item that the consumer wants to order","allOf":[{"$ref":"#/components/schemas/Item"}]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"ItemQuantity":{"description":"Describes the count or amount of an item","type":"object","additionalProperties":false,"properties":{"allocated":{"description":"This represents the exact quantity allocated for purchase of the item.","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"measure":{"$ref":"#/components/schemas/Scalar"}}},"available":{"description":"This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"measure":{"$ref":"#/components/schemas/Scalar"}}},"maximum":{"description":"This represents the maximum quantity allowed for purchase of the item","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":1},"measure":{"$ref":"#/components/schemas/Scalar"}}},"minimum":{"description":"This represents the minimum quantity allowed for purchase of the item","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"measure":{"$ref":"#/components/schemas/Scalar"}}},"selected":{"description":"This represents the quantity selected for purchase of the item","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"measure":{"$ref":"#/components/schemas/Scalar"}}},"unitized":{"description":"This represents the quantity available in a single unit of the item","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":1,"maximum":1},"measure":{"$ref":"#/components/schemas/Scalar"}}}}},"Item":{"description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.","type":"object","additionalProperties":false,"properties":{"id":{"description":"ID of the item.","type":"string"},"parent_item_id":{"description":"ID of the item, this item is a variant of","allOf":[{"$ref":"#/components/schemas/Item/properties/id"}]},"parent_item_quantity":{"description":"The number of units of the parent item this item is a multiple of","allOf":[{"$ref":"#/components/schemas/ItemQuantity"}]},"descriptor":{"description":"Physical description of the item","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"creator":{"description":"The creator of this item","allOf":[{"$ref":"#/components/schemas/Organization"}]},"price":{"description":"The price of this item, if it has intrinsic value","allOf":[{"$ref":"#/components/schemas/Price"}]},"quantity":{"description":"The selling quantity of the item","allOf":[{"$ref":"#/components/schemas/ItemQuantity"}]},"margin":{"description":"The selling margin of the item","allOf":[{"$ref":"#/components/schemas/ItemQuantity"}]},"category_ids":{"description":"Categories this item can be listed under","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Category/properties/id"}]}},"fulfillment_ids":{"description":"Modes through which this item can be fulfilled","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Fulfillment/properties/id"}]}},"location_ids":{"description":"Provider Locations this item is available in","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Location/properties/id"}]}},"payment_ids":{"description":"Payment modalities through which this item can be ordered","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Payment/properties/id"}]}},"add_ons":{"type":"array","items":{"$ref":"#/components/schemas/AddOn"}},"cancellation_terms":{"description":"Cancellation terms of this item","type":"array","items":{"$ref":"#/components/schemas/CancellationTerm"}},"refund_terms":{"description":"Refund terms of this item","type":"array","items":{"description":"Refund term of an item or an order","type":"object","additionalProperties":false,"properties":{"fulfillment_state":{"description":"The state of fulfillment during which this term is applicable.","allOf":[{"$ref":"#/components/schemas/State"}]},"refund_eligible":{"description":"Indicates if cancellation will result in a refund","type":"boolean"},"refund_within":{"description":"Time within which refund will be processed after successful cancellation.","allOf":[{"$ref":"#/components/schemas/Time"}]},"refund_amount":{"$ref":"#/components/schemas/Price"}}}},"replacement_terms":{"description":"Terms that are applicable be met when this item is replaced","type":"array","items":{"$ref":"#/components/schemas/ReplacementTerm"}},"return_terms":{"description":"Terms that are applicable when this item is returned","type":"array","items":{"$ref":"#/components/schemas/ReturnTerm"}},"xinput":{"description":"Additional input required from the customer to purchase / avail this item","allOf":[{"$ref":"#/components/schemas/XInput"}]},"time":{"description":"Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.","allOf":[{"$ref":"#/components/schemas/Time"}]},"rateable":{"description":"Whether this item can be rated","type":"boolean"},"rating":{"description":"The rating of the item","allOf":[{"$ref":"#/components/schemas/Rating/properties/value"}]},"matched":{"description":"Whether this item is an exact match of the request","type":"boolean"},"related":{"description":"Whether this item is a related item to the exactly matched item","type":"boolean"},"recommended":{"description":"Whether this item is a recommended item to a response","type":"boolean"},"ttl":{"description":"Time to live in seconds for an instance of this schema","type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}},"creds":{"type":"array","items":{"$ref":"#/components/schemas/Credential"}}}},"Location":{"description":"The physical location of something","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"map_url":{"description":"The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.","type":"string","format":"uri"},"gps":{"description":"The GPS co-ordinates of this location.","allOf":[{"$ref":"#/components/schemas/Gps"}]},"updated_at":{"type":"string","format":"date-time"},"address":{"description":"The address of this location.","allOf":[{"$ref":"#/components/schemas/Address"}]},"city":{"description":"The city this location is, or is located within","allOf":[{"$ref":"#/components/schemas/City"}]},"district":{"description":"The state this location is, or is located within","type":"string"},"state":{"description":"The state this location is, or is located within","allOf":[{"$ref":"#/components/schemas/State"}]},"country":{"description":"The country this location is, or is located within","allOf":[{"$ref":"#/components/schemas/Country"}]},"area_code":{"type":"string"},"circle":{"$ref":"#/components/schemas/Circle"},"polygon":{"description":"The boundary polygon of this location","type":"string"},"3dspace":{"description":"The three dimensional region describing this location","type":"string"},"rating":{"description":"The rating of this location","allOf":[{"$ref":"#/components/schemas/Rating/properties/value"}]},"time":{"description":"Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Time"}]}}}},"MediaFile":{"description":"This object contains a url to a media file.","type":"object","additionalProperties":false,"properties":{"mimetype":{"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":{"description":"The URL of the file","type":"string","format":"uri"},"signature":{"description":"The digital signature of the file signed by the sender","type":"string"},"dsa":{"description":"The signing algorithm used by the sender","type":"string"}}},"Offer":{"description":"An offer associated with a catalog. This is typically used to promote a particular product and enable more purchases.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"location_ids":{"type":"array","items":{"$ref":"#/components/schemas/Location/properties/id"}},"category_ids":{"type":"array","items":{"$ref":"#/components/schemas/Category/properties/id"}},"item_ids":{"type":"array","items":{"$ref":"#/components/schemas/Item/properties/id"}},"time":{"$ref":"#/components/schemas/Time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"Option":{"description":"Describes a selectable option","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"descriptor":{"$ref":"#/components/schemas/Descriptor"}}},"Order":{"description":"Describes a legal purchase order. It contains the complete details of the legal contract created between the buyer and the seller.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Human-readable ID of the order. This is generated at the BPP layer. The BPP can either generate order id within its system or forward the order ID created at the provider level."},"ref_order_ids":{"description":"A list of order IDs to link this order to previous orders.","type":"array","items":{"type":"string","description":"ID of a previous order"}},"status":{"description":"Status of the order. Allowed values can be defined by the network policy","type":"string","enum":["ACTIVE","COMPLETE","CANCELLED","COMPLETED","SOFT_CANCEL","CANCELLATION_INITIATED","CANCELLATION_REJECTED","SOFT_UPDATE","CONFIRM_UPDATE","UPDATED"]},"type":{"description":"This is used to indicate the type of order being created to BPPs. Sometimes orders can be linked to previous orders, like a replacement order in a retail domain. A follow-up consultation in healthcare domain. A single order part of a subscription order. The list of order types can be standardized at the network level.","type":"string","default":"DEFAULT","enum":["DRAFT","DEFAULT"]},"provider":{"description":"Details of the provider whose catalog items have been selected.","allOf":[{"$ref":"#/components/schemas/Provider"}]},"items":{"description":"The items purchased / availed in this order","type":"array","items":{"$ref":"#/components/schemas/Item"}},"add_ons":{"description":"The add-ons purchased / availed in this order","type":"array","items":{"$ref":"#/components/schemas/AddOn"}},"offers":{"description":"The offers applied in this order","type":"array","items":{"$ref":"#/components/schemas/Offer"}},"billing":{"description":"The billing details of this order","allOf":[{"$ref":"#/components/schemas/Billing"}]},"fulfillments":{"description":"The fulfillments involved in completing this order","type":"array","items":{"$ref":"#/components/schemas/Fulfillment"}},"cancellation":{"description":"The cancellation details of this order","allOf":[{"$ref":"#/components/schemas/Cancellation"}]},"cancellation_terms":{"description":"Cancellation terms of this item","type":"array","items":{"$ref":"#/components/schemas/CancellationTerm"}},"documents":{"type":"array","items":{"description":"Documnents associated to the order","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"mime_type":{"description":"This field indicates the nature and format of the form received by querying the url. MIME types are defined and standardized in IETF's RFC 6838.","type":"string","enum":["text/html","application/html","application/xml","application/pdf"]},"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.","type":"string","format":"uri"}}}},"refund_terms":{"description":"Refund terms of this item","type":"array","items":{"$ref":"#/components/schemas/Item/properties/refund_terms/items"}},"replacement_terms":{"description":"Replacement terms of this item","type":"array","items":{"$ref":"#/components/schemas/ReplacementTerm"}},"return_terms":{"description":"Return terms of this item","type":"array","items":{"$ref":"#/components/schemas/ReturnTerm"}},"quote":{"description":"The mutually agreed upon quotation for this order.","allOf":[{"$ref":"#/components/schemas/Quotation"}]},"payments":{"description":"The terms of settlement for this order","type":"array","items":{"$ref":"#/components/schemas/Payment"}},"created_at":{"description":"The date-time of creation of this order","type":"string","format":"date-time"},"updated_at":{"description":"The date-time of updated of this order","type":"string","format":"date-time"},"xinput":{"description":"Additional input required from the customer to confirm this order","allOf":[{"$ref":"#/components/schemas/XInput"}]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"Organization":{"description":"An organization. Usually a recognized business entity.","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"address":{"description":"The postal address of the organization","allOf":[{"$ref":"#/components/schemas/Address"}]},"state":{"description":"The state where the organization's address is registered","allOf":[{"$ref":"#/components/schemas/State"}]},"city":{"description":"The city where the the organization's address is registered","allOf":[{"$ref":"#/components/schemas/City"}]},"contact":{"$ref":"#/components/schemas/Contact"}}},"Payment":{"description":"Describes the terms of settlement between the BAP and the BPP for a single transaction. When instantiated, this object contains
  1. the amount that has to be settled,
  2. The payment destination destination details
  3. When the settlement should happen, and
  4. A transaction reference ID
. During a transaction, the BPP reserves the right to decide the terms of payment. However, the BAP can send its terms to the BPP first. If the BPP does not agree to those terms, it must overwrite the terms and return them to the BAP. If overridden, the BAP must either agree to the terms sent by the BPP in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the BAP and the BPP can perform offline negotiations on the payment terms. Once an agreement is reached, the BAP and BPP can resume transactions.","type":"object","additionalProperties":false,"properties":{"id":{"description":"ID of the payment term that can be referred at an item or an order level in a catalog","type":"string"},"collected_by":{"description":"This field indicates who is the collector of payment. The BAP can set this value to 'bap' if it wants to collect the payment first and settle it to the BPP. If the BPP agrees to those terms, the BPP should not send the payment url. Alternatively, the BPP can set this field with the value 'bpp' if it wants the payment to be made directly.","type":"string"},"url":{"type":"string","description":"A payment url to be called by the BAP. If empty, then the payment is to be done offline. The details of payment should be present in the params object. If tl_method = http/get, then the payment details will be sent as url params. Two url param values, ```$transaction_id``` and ```$amount``` are mandatory.","format":"uri"},"tl_method":{"type":"string"},"params":{"type":"object","additionalProperties":false,"properties":{"transaction_id":{"type":"string","description":"The reference transaction ID associated with a payment activity"},"amount":{"type":"string"},"currency":{"type":"string"},"bank_code":{"type":"string"},"bank_account_number":{"type":"string"},"virtual_payment_address":{"type":"string"},"source_bank_code":{"type":"string"},"source_bank_account_number":{"type":"string"},"source_virtual_payment_address":{"type":"string"}}},"type":{"type":"string","enum":["PRE_ORDER","PRE_FULFILLMENT","ON_FULFILLMENT","POST_FULFILLMENT","ON_ORDER","PART_PAYMENT","ON_CANCELLATION","POST_CANCELLATION"]},"status":{"type":"string","enum":["PAID","NOT_PAID"]},"time":{"$ref":"#/components/schemas/Time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"Person":{"description":"Describes a person as any individual","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Describes the identity of the person"},"url":{"description":"Profile url of the person","type":"string","format":"uri"},"name":{"description":"the name of the person","type":"string"},"image":{"$ref":"#/components/schemas/Image"},"age":{"description":"Age of the person","allOf":[{"$ref":"#/components/schemas/Duration"}]},"dob":{"description":"Date of birth of the person","type":"string","format":"date"},"gender":{"type":"string","description":"Gender of something, typically a Person, but possibly also fictional characters, animals, etc. While Male and Female may be used, text strings are also acceptable for people who do not identify as a binary gender.Allowed values for this field can be published in the network policy"},"creds":{"type":"array","items":{"$ref":"#/components/schemas/Credential"}},"languages":{"type":"array","items":{"description":"Describes a language known to the person.","type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"name":{"type":"string"}}}},"skills":{"type":"array","items":{"description":"Describes a skill of the person.","type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"name":{"type":"string"}}}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}},"descriptor":{"$ref":"#/components/schemas/Descriptor"}}},"Price":{"description":"Describes the price of a product or service","type":"object","additionalProperties":false,"properties":{"currency":{"type":"string"},"value":{"$ref":"#/components/schemas/DecimalValue"},"estimated_value":{"$ref":"#/components/schemas/DecimalValue"},"computed_value":{"$ref":"#/components/schemas/DecimalValue"},"listed_value":{"$ref":"#/components/schemas/DecimalValue"},"offered_value":{"$ref":"#/components/schemas/DecimalValue"},"minimum_value":{"$ref":"#/components/schemas/DecimalValue"},"maximum_value":{"$ref":"#/components/schemas/DecimalValue"}}},"Provider":{"description":"Describes the catalog of a business.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Id of the provider"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"category_id":{"type":"string","description":"Category Id of the provider at the BPP-level catalog"},"rating":{"$ref":"#/components/schemas/Rating/properties/value"},"time":{"$ref":"#/components/schemas/Time"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"fulfillments":{"type":"array","items":{"$ref":"#/components/schemas/Fulfillment"}},"payments":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"}},"offers":{"type":"array","items":{"$ref":"#/components/schemas/Offer"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"exp":{"type":"string","description":"Time after which catalog has to be refreshed","format":"date-time"},"rateable":{"description":"Whether this provider can be rated or not","type":"boolean"},"ttl":{"description":"The time-to-live in seconds, for this object. This can be overriden at deeper levels. A value of -1 indicates that this object is not cacheable.","type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}},"cancellation_terms":{"description":"Cancellation terms of this item","type":"array","items":{"$ref":"#/components/schemas/CancellationTerm"}}}},"Quotation":{"description":"Describes a quote. It is the estimated price of products or services from the BPP.
This has properties like price, breakup, ttl","type":"object","additionalProperties":false,"properties":{"id":{"description":"ID of the quote.","type":"string"},"price":{"description":"The total quoted price","allOf":[{"$ref":"#/components/schemas/Price"}]},"breakup":{"description":"the breakup of the total quoted price","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"item":{"$ref":"#/components/schemas/Item"},"title":{"type":"string"},"price":{"$ref":"#/components/schemas/Price"}}}},"ttl":{"$ref":"#/components/schemas/Duration"}}},"Rating":{"description":"Describes the rating of an entity","type":"object","additionalProperties":false,"properties":{"rating_category":{"description":"Category of the entity being rated","type":"string","enum":["ITEM","ORDER","FULFILLMENT","PROVIDER","AGENT","SUPPORT"]},"id":{"description":"Id of the object being rated","type":"string"},"value":{"description":"Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.","type":"string"}}},"Region":{"description":"Describes an arbitrary region of space. The network policy should contain a published list of supported regions by the network.","type":"object","additionalProperties":false,"properties":{"dimensions":{"description":"The number of dimensions that are used to describe any point inside that region. The most common dimensionality of a region is 2, that represents an area on a map. There are regions on the map that can be approximated to one-dimensional regions like roads, railway lines, or shipping lines. 3 dimensional regions are rarer, but are gaining popularity as flying drones are being adopted for various fulfillment services.","type":"string","enum":["1","2","3"]},"type":{"description":"The type of region. This is used to specify the granularity of the region represented by this object. Various examples of two-dimensional region types are city, country, state, district, and so on. The network policy should contain a list of all possible region types supported by the network.","type":"string"},"name":{"type":"string","description":"Name of the region as specified on the map where that region exists."},"code":{"type":"string","description":"A standard code representing the region. This should be interpreted in the same way by all network participants."},"boundary":{"type":"string","description":"A string representing the boundary of the region. One-dimensional regions are represented by polylines. Two-dimensional regions are represented by polygons, and three-dimensional regions can represented by polyhedra."},"map_url":{"type":"string","description":"The url to the map of the region. This can be a globally recognized map or the one specified by the network policy."}}},"ReplacementTerm":{"description":"The replacement policy of an item or an order","type":"object","additionalProperties":false,"properties":{"fulfillment_state":{"description":"The state of fulfillment during which this term is applicable.","allOf":[{"$ref":"#/components/schemas/State"}]},"replace_within":{"description":"Applicable only for buyer managed returns where the buyer has to replace the item before a certain date-time, failing which they will not be eligible for replacement","allOf":[{"$ref":"#/components/schemas/Time"}]},"external_ref":{"$ref":"#/components/schemas/MediaFile"}}},"ReturnTerm":{"description":"Describes the return policy of an item or an order","type":"object","additionalProperties":false,"properties":{"fulfillment_state":{"description":"The state of fulfillment during which this term IETF''s applicable.","allOf":[{"$ref":"#/components/schemas/State"}]},"return_eligible":{"description":"Indicates whether the item is eligible for return","type":"boolean"},"return_time":{"description":"Applicable only for buyer managed returns where the buyer has to return the item to the origin before a certain date-time, failing which they will not be eligible for refund.","allOf":[{"$ref":"#/components/schemas/Time"}]},"return_location":{"description":"The location where the item or order must / will be returned to","allOf":[{"$ref":"#/components/schemas/Location"}]},"fulfillment_managed_by":{"description":"The entity that will perform the return","type":"string","enum":["CONSUMER","PROVIDER"]}}},"Scalar":{"description":"Describes a scalar","type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["CONSTANT","VARIABLE"]},"value":{"$ref":"#/components/schemas/DecimalValue"},"estimated_value":{"$ref":"#/components/schemas/DecimalValue"},"computed_value":{"$ref":"#/components/schemas/DecimalValue"},"range":{"type":"object","additionalProperties":false,"properties":{"min":{"$ref":"#/components/schemas/DecimalValue"},"max":{"$ref":"#/components/schemas/DecimalValue"}}},"unit":{"type":"string"}}},"Schedule":{"description":"Describes schedule as a repeating time period used to describe a regularly recurring event. At a minimum a schedule will specify frequency which describes the interval between occurrences of the event. Additional information can be provided to specify the schedule more precisely. This includes identifying the timestamps(s) of when the event will take place. Schedules may also have holidays to exclude a specific day from the schedule.
This has properties like frequency, holidays, times","type":"object","additionalProperties":false,"properties":{"frequency":{"$ref":"#/components/schemas/Duration"},"holidays":{"type":"array","items":{"type":"string","format":"date-time"}},"times":{"type":"array","items":{"type":"string","format":"date-time"}}}},"State":{"description":"A bounded geopolitical region of governance inside a country.","type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the state"},"code":{"type":"string","description":"State code as per country or international standards"}}},"Stop":{"description":"A logical point in space and time during the fulfillment of an order.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"parent_stop_id":{"type":"string"},"location":{"description":"Location of the stop","allOf":[{"$ref":"#/components/schemas/Location"}]},"type":{"description":"The type of stop. Allowed values of this property can be defined by the network policy.","type":"string"},"time":{"description":"Timings applicable at the stop.","allOf":[{"$ref":"#/components/schemas/Time"}]},"instructions":{"description":"Instructions that need to be followed at the stop","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"contact":{"description":"Contact details of the stop","allOf":[{"$ref":"#/components/schemas/Contact"}]},"person":{"description":"The details of the person present at the stop","allOf":[{"$ref":"#/components/schemas/Person"}]},"authorization":{"$ref":"#/components/schemas/Authorization"}}},"Support":{"description":"Details of customer support","type":"object","additionalProperties":false,"properties":{"ref_id":{"type":"string"},"callback_phone":{"type":"string","format":"phone"},"phone":{"type":"string","format":"phone"},"email":{"type":"string","format":"email"},"url":{"type":"string","format":"uri"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"ref_type":{"type":"string"}}},"Tag":{"description":"Describes a tag. This is used to contain extended metadata. This object can be added as a property to any schema to describe extended attributes. For BAPs, tags can be sent during search to optimize and filter search results. BPPs can use tags to index their catalog to allow better search functionality. Tags are sent by the BPP as part of the catalog response in the `on_search` callback. Tags are also meant for display purposes. Upon receiving a tag, BAPs are meant to render them as name-value pairs. This is particularly useful when rendering tabular information about a product or service.","type":"object","additionalProperties":false,"properties":{"descriptor":{"description":"Description of the Tag, can be used to store detailed information.","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"value":{"description":"The value of the tag. This set by the BPP and rendered as-is by the BAP.","type":"string"},"display":{"description":"This value indicates if the tag is intended for display purposes. If set to `true`, then this tag must be displayed. If it is set to `false`, it should not be displayed. This value can override the group display value.","type":"boolean"}}},"TagGroup":{"description":"A collection of tag objects with group level attributes. For detailed documentation on the Tags and Tag Groups schema go to https://github.com/beckn/protocol-specifications/discussions/316","type":"object","additionalProperties":false,"properties":{"display":{"description":"Indicates the display properties of the tag group. If display is set to false, then the group will not be displayed. If it is set to true, it should be displayed. However, group-level display properties can be overriden by individual tag-level display property. As this schema is purely for catalog display purposes, it is not recommended to send this value during search.","type":"boolean","default":true},"descriptor":{"description":"Description of the TagGroup, can be used to store detailed information.","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"list":{"description":"An array of Tag objects listed under this group. This property can be set by BAPs during search to narrow the `search` and achieve more relevant results. When received during `on_search`, BAPs must render this list under the heading described by the `name` property of this schema.","type":"array","items":{"$ref":"#/components/schemas/Tag"}}}},"Time":{"description":"Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operations
This has properties like label, time stamp,duration,range, days, schedule","type":"object","additionalProperties":false,"properties":{"label":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"duration":{"$ref":"#/components/schemas/Duration"},"range":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"days":{"type":"string","description":"comma separated values representing days of the week"},"schedule":{"$ref":"#/components/schemas/Schedule"}}},"Tracking":{"description":"Contains tracking information that can be used by the BAP to track the fulfillment of an order in real-time. which is useful for knowing the location of time sensitive deliveries.","type":"object","additionalProperties":false,"properties":{"id":{"description":"A unique tracking reference number","type":"string"},"url":{"description":"A URL to the tracking endpoint. This can be a link to a tracking webpage, a webhook URL created by the BAP where BPP can push the tracking data, or a GET url creaed by the BPP which the BAP can poll to get the tracking data. It can also be a websocket URL where the BPP can push real-time tracking data.","type":"string","format":"uri"},"location":{"description":"In case there is no real-time tracking endpoint available, this field will contain the latest location of the entity being tracked. The BPP will update this value everytime the BAP calls the track API.","allOf":[{"$ref":"#/components/schemas/Location"}]},"status":{"description":"This value indicates if the tracking is currently active or not. If this value is `active`, then the BAP can begin tracking the order. If this value is `inactive`, the tracking URL is considered to be expired and the BAP should stop tracking the order.","type":"string","enum":["active","inactive"]}}},"Vehicle":{"description":"Describes a vehicle is a device that is designed or used to transport people or cargo over land, water, air, or through space.
This has properties like category, capacity, make, model, size,variant,color,energy_type,registration","type":"object","additionalProperties":false,"properties":{"category":{"type":"string"},"capacity":{"type":"integer"},"make":{"type":"string"},"model":{"type":"string"},"size":{"type":"string"},"variant":{"type":"string"},"color":{"type":"string"},"energy_type":{"type":"string"},"registration":{"type":"string"},"wheels_count":{"type":"string"},"cargo_volumne":{"type":"string"},"wheelchair_access":{"type":"string"},"code":{"type":"string"},"emission_standard":{"type":"string"}}},"XInput":{"description":"Contains any additional or extended inputs required to confirm an order. This is typically a Form Input. Sometimes, selection of catalog elements is not enough for the BPP to confirm an order. For example, to confirm a flight ticket, the airline requires details of the passengers along with information on baggage, identity, in addition to the class of ticket. Similarly, a logistics company may require details on the nature of shipment in order to confirm the shipping. A recruiting firm may require additional details on the applicant in order to confirm a job application. For all such purposes, the BPP can choose to send this object attached to any object in the catalog that is required to be sent while placing the order. This object can typically be sent at an item level or at the order level. The item level XInput will override the Order level XInput as it indicates a special requirement of information for that particular item. Hence the BAP must render a separate form for the Item and another form at the Order level before confirmation.","type":"object","additionalProperties":false,"properties":{"head":{"description":"Provides the header information for the xinput.","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"index":{"type":"object","additionalProperties":false,"properties":{"min":{"type":"integer"},"cur":{"type":"integer"},"max":{"type":"integer"}}},"headings":{"type":"array","items":{"type":"string","description":"The heading names of the forms"}}}},"form":{"$ref":"#/components/schemas/Form"},"form_response":{"description":"Describes the response to a form submission","type":"object","additionalProperties":false,"properties":{"status":{"description":"Contains the status of form submission.","type":"string"},"signature":{"type":"string"},"submission_id":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}},"required":{"description":"Indicates whether the form data is mandatorily required by the BPP to confirm the order.","type":"boolean"}}}}},"x-enum":{"search":{"context":{"action":[{"code":"search","description":"Buyer app indicates the search intent","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"intent":{"category":{"descriptor":{"code":[{"code":"ON_DEMAND_TRIP","description":"Describes the category of the on_demand offer","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"catalog":{"providers":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]}},"on_status":{"context":{"action":[{"code":"on_status","description":"Seller app return order with status , Driver pickup - driver drop","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}]}}}}},"cancel":{"context":{"action":[{"code":"cancel","description":"Buyer app requests order cancellation.\"","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"cancellation_reason_id":[{"code":"000","description":"Technical cancellation of orders in case protocol technical failures(BAP/BPP)","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""},{"code":"PROVIDER","description":"Describes, when the ride is cancelled by the provider.","reference":""}],"reason":{"descriptor":{"code":[{"code":"000","description":"Technical cancellation of orders in case protocol technical failures(BAP/BPP)","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]}},"on_track":{"context":{"action":[{"code":"on_track","description":"Seller app specifies the on_track.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]}}},"x-tags":{"search":{"message":{"intent":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"item":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]}]}}}},"on_search":{"message":{"catalog":{"tags":[{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"providers":{"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]}}}}},"on_select":{"message":{"order":{"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"init":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}]}}},"on_init":{"message":{"order":{"tags":[{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"confirm":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"on_confirm":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"on_status":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"on_cancel":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"on_update":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}}},"x-flows":[{"summary":"On-Demand - Assign driver on on-confirm","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"payment_ids":["PA1","PA2"],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"id":"PA1","type":"ON_FULFILLMENT","collected_by":"BPP","status":"NOT_PAID"},{"id":"PA2","type":"POST_CANCELLATION","status":"NOT_PAID","collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver on on-confirm (Add Ons)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"available":{"count":1},"maximum":{"count":1}}}],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"available":{"count":1},"maximum":{"count":1}}}],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"he Buyer App selects a specific service and may optionally choose add-ons","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":1}}}]}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":1}}}]}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":1}}}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver on on-confirm(BAP Collecting)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[BAP Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BAP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[BAP Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[BAP Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BAP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[BAP Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app provides the payment update to Seller app","api":"update","details":[{"description":"Buyer app provides the payment update to Seller app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Buyer app provides the payment update to Seller app","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"47e05cc2-2bc4-41c9-81fb-26be6ae74403","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.payments","order":{"id":"01","payments":[{"collected_by":"BAP","id":"PA1","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"},"status":"PAID","type":"ON_FULFILLMENT"}]}}}}},{"summary":"Seller app provides the latest order status with updated payment details","api":"on_update","details":[{"description":"Seller app provides the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n \n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Seller app provides the latest order status","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver on on-confirm(BAP Collecting, On-Order)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[BAP Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BAP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[BAP Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[BAP Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BAP","status":"NOT_PAID","type":"PRE_ORDER"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[BAP Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"PRE_ORDER"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver on on-confirm(BAP Collecting, Quote-Update)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[BAP Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BAP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[BAP Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[BAP Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BAP","status":"NOT_PAID","type":"PRE_ORDER"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[BAP Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"PRE_ORDER"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride with updated fare details (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}},{"collected_by":"BAP","id":"PA2","status":"NOT_PAID","type":"POST_FULFILLMENT","params":{"amount":"10","currency":"INR"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app provides the payment update to Seller app","api":"update","details":[{"description":"Buyer app provides the payment update to Seller app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Buyer app provides the payment update to Seller app","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"47e05cc2-2bc4-41c9-81fb-26be6ae74403","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.payments","order":{"id":"01","payments":[{"collected_by":"BAP","id":"PA2","params":{"amount":"10","currency":"INR","transaction_id":"3cb81b36-5997-4fa9-9b5f-5b0b1ae25001"},"status":"PAID","type":"POST_FULFILLMENT"}]}}}}},{"summary":"Seller app provides the latest order status with updated payment details","api":"on_update","details":[{"description":"Seller app provides the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n \n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Seller app provides the latest order status","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}},{"collected_by":"BAP","id":"PA2","params":{"amount":"10","currency":"INR","transaction_id":"3cb81b36-5997-4fa9-9b5f-5b0b1ae25001"},"status":"PAID","type":"POST_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver post on-confirm","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"payment_ids":["PA1","PA2"],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"id":"PA1","type":"ON_FULFILLMENT","collected_by":"BPP","status":"NOT_PAID"},{"id":"PA2","type":"POST_CANCELLATION","status":"NOT_PAID","collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:48:34.53Z","tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the latest update on ride details to the buyer app.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy"}},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Assign driver post on-confirm(Self-Pickup)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"On Demand"}}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"payments":[{"collected_by":"BPP"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}]}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}]}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the latest update on ride details to the buyer app.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_status","details":[{"description":"Ride provider provides the latest update on ride details to the buyer app with fulfillment state - RIDE_STARTED","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"PAID","type":"ON_FULFILLMENT","params":{"amount":"146"}}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Female Driver Flow","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"customer":{"person":{"gender":"FEMALE"}},"agent":{"person":{"gender":"FEMALE"}},"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}},{"id":"F3","customer":{"person":{"gender":"FEMALE"}},"agent":{"person":{"gender":"FEMALE"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"CAB Economy Ride – Female Driver"},"category_ids":["C1"],"fulfillment_ids":["F3"],"id":"I3","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"matched":true,"recommended":false},{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"matched":false,"recommended":true},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"matched":false,"recommended":true}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Ride cancellation by driver","details":[{"description":"Detailed process of cancelling a ride with soft & confirm status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel (unsolicited)\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK "}],"steps":[{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel (unsolicited)\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider accepts the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel (unsolicited)\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end "}],"reference":"if any","example":{"summary":"Return current order status after confirm-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"0"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"0"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"PROVIDER","reason":{"descriptor":{"code":"013"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Ride cancellation by rider","details":[{"description":"Detailed process of cancelling a ride with soft & confirm status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app cancels the request for ride","api":"cancel","details":[{"description":"Buyer app requests for cancellation of ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with soft cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation_reason_id":"002","descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts/appends the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after soft-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the cancel request for ride","api":"cancel","details":[{"description":"Buyer app give the confirmation to cancel the ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with confirm cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation_reason_id":"002","descriptor":{"code":"CONFIRM_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after confirm-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"ACTIVE","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Technical Cancellation Flow","details":[{"description":"Detailed process of cancelling a ride with soft & confirm status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): NACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK \n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK "}],"reference":"if any","steps":[{"summary":"Provider confirms the request","api":"on_confirm","details":[{"description":"The provider has confirmed the request, but the buyer app received the request after the TTL had expired.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): NACK \n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK "}],"reference":"if any","example":{"value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app request for latest order status","api":"status","details":[{"description":"Buyer app request for latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): NACK \n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK "}],"reference":"if any","example":{"value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"ref_id":"870782be-6757-43f1-945c-8eeaf9536259"}}}},{"summary":"Provider sends the latest order status","api":"on_status","details":[{"description":"Provider sends the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): NACK \n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app cancels the request for ride(Optional)","api":"cancel","details":[{"description":"Buyer app requests for cancellation of ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8bbe4998-6243-4ce6-9859-c0f21c06d3db","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation_reason_id":"000","descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Provider accepts/appends the terms of cancellation(Optional)","api":"on_cancel","details":[{"description":"Provider accepts the terms of order and appends its own terms and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"000"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the cancel request for ride","api":"cancel","details":[{"description":"Buyer app give the confirmation to cancel the ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8bbe4998-6243-4ce6-9859-c0f21c06d3db","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation_reason_id":"000","descriptor":{"code":"CONFIRM_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Provider accepts the terms of cancellation","api":"on_cancel","details":[{"description":"Provider accepts the terms of order and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end "}],"reference":"if any","example":{"value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"000"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"Driver not found on on_confirm","references":"if any","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","reference":"if any","api":"on_confirm","example":{"value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"error":{"code":"90203","message":"Driver not assigned to the order"}}},"details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}]}]},{"summary":"Driver not found post on_confirm","references":"if any","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","reference":"if any","api":"on_confirm","example":{"value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:48:34.53Z","tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},"details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}]},{"summary":"Ride not found after on_confirm","reference":"if any","api":"on_cancel","example":{"value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"PROVIDER","reason":{"descriptor":{"code":"011"}}},"created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},"details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}]}]},{"summary":"On-Demand - Ride with multiple stops","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816","address":"XYZ, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END","id":"3","parent_stop_id":"2"}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","category_ids":["C1"],"location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","category_ids":["C1"],"location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","category_ids":["C1"],"location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Update Stop","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app requests for update of stop","api":"update","details":[{"description":"Buyer app request the provider platform to update the stop","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With fulfillment id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Update an active ride","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.fulfillments","order":{"id":"01","status":"SOFT_UPDATE","fulfillments":[{"id":"F1","stops":[{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}]}]}}}}},{"summary":"Provider platform confirms with on_update request","api":"on_update","details":[{"description":"Provider platform provides the updated order details","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"SOFT_UPDATE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for update of stop","api":"update","details":[{"description":"Buyer app request the provider platform to update the stop","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With fulfillment id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Update an active ride","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"47e05cc2-2bc4-41c9-81fb-26be6ae74403","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.fulfillments","order":{"id":"01","status":"CONFIRM_UPDATE","fulfillments":[{"id":"F1","stops":[{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}]}]}}}}},{"summary":"Provider platform confirms with on_update request","api":"on_update","details":[{"description":"Provider platform provides the updated order details","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"UPDATED","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Provider platform provide the latest order status","api":"on_status","details":[{"description":"Provider platform provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Pre Order Bid","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"payment_ids":["PA1","PA2"],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"id":"PA1","type":"ON_FULFILLMENT","collected_by":"BPP","status":"NOT_PAID"},{"id":"PA2","type":"POST_CANCELLATION","status":"NOT_PAID","collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","price":{"currency":"INR","value":"166"}}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"166"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"20"},"title":"BUYER_ADDITIONAL_AMOUNT"}],"price":{"currency":"INR","value":"166"},"ttl":"PT30S"}}}}}}]},{"summary":"On-Demand - Post Order Tip","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for update of quote (tipping)","api":"update","details":[{"description":"Buyer app requests for update of quote (tipping)","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With order id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated quote\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Update an active ride","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.quote.breakup","order":{"id":"O1","quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"20"},"title":"BUYER_ADDITIONAL_AMOUNT"}],"price":{"currency":"INR","value":"166"}}}}}}},{"summary":"Provider platform confirms with on_update request","api":"on_update","details":[{"description":"Provider platform provides the updated order details","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update quote\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated quote\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"PT60M"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"Delivery"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"DELAY_INTEREST"},"value":"2.5"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"1.46"},{"descriptor":{"code":"SETTLEMENT_BANK_CODE"},"value":"XXXXXXXX"},{"descriptor":{"code":"SETTLEMENT_BANK_ACCOUNT_NUMBER"},"value":"xxxxxxxxxxxxxx"},{"descriptor":{"code":"SETTLEMENT_VIRTUAL_PAYMENT_ADDRESS"},"value":"9988199772@okicic"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"20"},"title":"BUYER_ADDITIONAL_AMOUNT"}],"price":{"currency":"INR","value":"166"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Rental","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_RENTAL"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"circle":{"gps":"13.008935, 77.644408","radius":{"type":"CONSTANT","value":"100","unit":"KILOMETER"}}},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"category_ids":["C3"],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C3"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"add_ons":[{"id":"A2","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"1","unit":"HOURS"}}},"descriptor":{"name":"time","code":"TIME"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C3","descriptor":{"code":"ON_DEMAND_RENTAL","name":"Rental"}}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","category_ids":["C3"],"location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"Schedule - Rental","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"SCHEDULED_RENTAL"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C4"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"add_ons":[{"id":"A2","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"1","unit":"HOURS"}}},"descriptor":{"name":"time","code":"TIME"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C4","descriptor":{"code":"SCHEDULED_RENTAL","name":"Rental"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides the agent details","api":"on_update","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"4ce7055d-2511-4586-b18f-b50822048447","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACKs\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"Schedule - Trip","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title schedule Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"SCHEDULED_TRIP"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"}},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C2"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C2","descriptor":{"code":"SCHEDULED_TRIP","name":"scheduled"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides the agent details","api":"on_update","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n \n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Rental(when end stop gps coordinate is present)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_RENTAL"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"category_ids":["C3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C3"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"add_ons":[{"id":"A2","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"1","unit":"HOURS"}}},"descriptor":{"name":"time","code":"TIME"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C3","descriptor":{"code":"ON_DEMAND_RENTAL","name":"Rental"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"No Acceptance - Soft_Cancel","details":[{"description":"Detailed process of No Acceptance flow atter soft_cancel.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app cancels the request for ride","api":"cancel","details":[{"description":"Buyer app requests for cancellation of ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with soft cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation_reason_id":"002","descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts/appends the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return current order status after soft-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"time":{"duration":"PT2H"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"CAB Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider sends unsolicited on_status call","api":"on_status","details":[{"description":"The ride provider sends an unsolicited on_status call and reverted to the original order state as no response was received from the buyer app within the defined TTL.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after soft-cancel","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"975ff507-439e-4933-acf4-4aaed4af0d51","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"time":{"duration":"PT2H"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"CAB Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"No Acceptance - Soft_Update","details":[{"description":"Detailed process of No Acceptance flow atter soft_update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With fulfillment id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app requests for update of stop","api":"update","details":[{"description":"Buyer app request the provider platform to update the stop","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With fulfillment id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Update an active ride","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.fulfillments","order":{"id":"01","status":"SOFT_UPDATE","fulfillments":[{"id":"F1","stops":[{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}]}]}}}}},{"summary":"Provider platform confirms with on_update request","api":"on_update","details":[{"description":"Provider platform provides the updated order details","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"SOFT_UPDATE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider sends unsolicited on_status call","api":"on_status","details":[{"description":"The ride provider sends an unsolicited on_status call and reverted to the original order state as no response was received from the buyer app within the defined TTL.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"a6ef2152-7cec-4560-b0ec-04fb13691813","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"BPP Collecting - Payment Confirmation","details":[{"description":"The illustrative flow depicts the comprehensive process of payment confirmation, showcasing the sequential steps and interactions involved in a payment transaction.","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP) ->> Buyer Platform (BAP) : form"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Buyer Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP) ->> Buyer Platform (BAP) : form"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Buyer Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app redirects to payment gateway page.","api":"form","details":[{"description":"Buyer app redirects to payment gateway page using the link provided in the previous step.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP) ->> Buyer Platform (BAP) : form\n end"}],"reference":"if any","example":{"value":"This will redirected to different html page"}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"ref_id":"870782be-6757-43f1-945c-8eeaf9536259"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Buyer Collecting]","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c","amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"}}}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"9a7be37d-f228-432b-9aa9-65144d48da38","timestamp":"2023-12-10T04:34:49.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"9a7be37d-f228-432b-9aa9-65144d48da38","timestamp":"2023-12-10T04:34:52.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c","amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T04:34:52.031Z","updated_at":"2023-12-10T04:34:52.031Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Purple Tags (Assign driver on on-confirm)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"eb60e750-2b11-4170-8bd3-b4c6370835d9","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare & list of supported purple tags.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"eb60e750-2b11-4170-8bd3-b4c6370835d9","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"category_ids":["C5"],"tags":[{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"}},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"}},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"}},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"}}]},{"descriptor":{"name":"Dwarfism","code":"DISABILITY_DWARFISM"},"display":false,"list":[{"descriptor":{"code":"DWARFISM_SPECIAL_REQUIREMENT","name":"Dwarfism","short_desc":"Custom description"}}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C5"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C5","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service & select specific purple tags.","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"01c1903c-f943-4c11-8e93-dff5ce3c30bd","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","tags":[{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"01c1903c-f943-4c11-8e93-dff5ce3c30bd","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"category_ids":["C5"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"category_ids":["C5"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}] "}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"category_ids":["C5"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Ride cancellation by rider(BAP Collecting)","details":[{"description":"Detailed process of cancelling a ride with soft & confirm status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app cancels the request for ride","api":"cancel","details":[{"description":"Buyer app requests for cancellation of ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with soft cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation_reason_id":"002","descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts/appends the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after soft-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"},{"collected_by":"BAP","id":"PA2","status":"NOT_PAID","type":"POST_CANCELLATION"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the cancel request for ride","api":"cancel","details":[{"description":"Buyer app give the confirmation to cancel the ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with confirm cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation_reason_id":"002","descriptor":{"code":"CONFIRM_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after confirm-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"},{"collected_by":"BAP","id":"PA2","status":"NOT_PAID","type":"POST_CANCELLATION"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"ACTIVE","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app shares the updated payment status with Seller app.","api":"update","details":[{"description":"Buyer app shares the updated payment status with Seller app.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Buyer app shares the updated payment status with Seller app.","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"396a3c9a-838d-46cd-8fd9-311b93cdb2d0","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.payments","order":{"id":"01","payments":[{"collected_by":"BAP","id":"PA2","params":{"amount":"10","currency":"INR","transaction_id":"ed8bebf6-1ed8-48d0-8506-e0bc35d93d60"},"status":"PAID","type":"POST_CANCELLATION"}]}}}}},{"summary":"Seller app shares the updated order status.","api":"on_update","details":[{"description":"Seller app shares the updated order status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Seller app shares the updated order status.","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"396a3c9a-838d-46cd-8fd9-311b93cdb2d0","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"},{"collected_by":"BAP","id":"PA2","params":{"amount":"10","currency":"INR","transaction_id":"ed8bebf6-1ed8-48d0-8506-e0bc35d93d60"},"status":"PAID","type":"POST_CANCELLATION"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Support","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"The Buyer App initiates the support request","api":"support","details":[{"description":"The Buyer App initiates the support request","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): support\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_support\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"support","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"396a3c9a-838d-46cd-8fd9-311b93cdb2d0","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"support":{"descriptor":{"code":"SOS","name":"sos emergency","short_desc":"Driver has deviated from the planned route."},"ref_type":"ORDER","ref_id":"O1"}}}}},{"summary":"The Seller App returns the on_support response to the Buyer App.","api":"on_support","details":[{"description":"The Seller App returns the on_support response to the Buyer App.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): support\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_support\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_support","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"396a3c9a-838d-46cd-8fd9-311b93cdb2d0","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"support":{"descriptor":{"code":"SOS","name":"sos emergency","short_desc":"Driver has deviated from the planned route."},"ref_type":"ORDER","ref_id":"O1","email":"support@example-bpp.com","phone":"+918068870525","url":"https://example-bpp.com/prod/seller/gethelp"}}}}}]}],"x-examples":{"on-demand":{"summary":"On Demand Use Case Specification","description":"The On-demand use case on the network would enable NPs to perform on-demand ride hailing related transactions on the network. These APIs are utilized by consumer and provider platforms enabling every consumer/ end-user on all consumer platforms to consume the services/ inventory provided by all provider platforms on the network seamlessly. Consumer platforms shall use these specifications to perform transaction operations like discovery, selection, booking, status check and others so as to purchase services/ inventory on the network eg: autos, cabs etc. Provider Platform shall use these specifications to expose their services/ inventory in form of autos or cabs rides. Gateway specifications are used to broadcast demands originating from a consumer platform to all applicable provider platforms in a transparent and unbiased manner.","example_set":{"cancel":{"examples":[{"summary":"Initiates_cancelling_a_ride_with_confirm_cancel_status___X5","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation_reason_id":"002","descriptor":{"code":"CONFIRM_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}},{"summary":"Initiates_cancelling_a_ride_with_soft_cancel_status___X4","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation_reason_id":"002","descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}]},"confirm":{"examples":[{"summary":"Confirm_ride_booking___X6","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"confirm_buyer_app_confirms_the_booking_and_provides_all_the_required_information_for_confirmation_as_per_the_terms_of_the_order__5","description":"TBD","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"confirm_buyer_app_confirms_the_booking_and_provides_all_the_required_information_for_confirmation_as_per_the_terms_of_the_order__6","description":"TBD","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"9a7be37d-f228-432b-9aa9-65144d48da38","timestamp":"2023-12-10T04:34:49.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"init":{"examples":[{"summary":"Initialize_draft_order_and_request_for_terms_of_service[Seller_Collecting]___X7","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}},{"summary":"init_buyer_app_platform_shares_the_terms_of_order_and_initializes_the_request__1","description":"TBD","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"init_buyer_app_platform_shares_the_terms_of_order_and_initializes_the_request__3","description":"TBD","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"on_cancel":{"examples":[{"summary":"Return_current_order_status_after_confirm-cancel___X9","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"0"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"0"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"PROVIDER","reason":{"descriptor":{"code":"013"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"Return_current_order_status_after_soft-cancel___X8","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"time":{"duration":"PT2H"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"CAB Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"cancel_after_confirm","description":"TBD","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"PROVIDER","reason":{"descriptor":{"code":"011"}}},"created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"on_confirm":{"examples":[{"summary":"Return_confirmed_order_with_latest_fulfillment_details___X10","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"Return_confirmed_order_with_latest_fulfillment_details___X11","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:48:34.53Z","tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"Return_confirmed_order_with_latest_fulfillment_details___X12","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","params":{"amount":"146","currency":"INR","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259"},"status":"PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"DELAY_INTEREST"},"value":"5"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"P2D"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"DELIVERY"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"144.54"},{"descriptor":{"code":"SETTLEMENT_BANK_CODE"},"value":"XXXXXXXX"},{"descriptor":{"code":"SETTLEMENT_BANK_ACCOUNT_NUMBER"},"value":"xxxxxxxxxxxxxx"},{"descriptor":{"code":"SETTLEMENT_VIRTUAL_PAYMENT_ADDRESS"},"value":"9988199772@okicic"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}},{"summary":"on_confirm_ride_provider_confirms_the_ride_request_and_provides_the_ride_details_on_confirmation__6","description":"TBD","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_confirm_ride_provider_confirms_the_ride_request_and_provides_the_ride_details_on_confirmation__7","description":"TBD","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"9a7be37d-f228-432b-9aa9-65144d48da38","timestamp":"2023-12-10T04:34:52.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c","amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T04:34:52.031Z","updated_at":"2023-12-10T04:34:52.031Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"ride_cancelled","description":"TBD","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"error":{"code":"90203","message":"Driver not assigned to the order"}}}]},"on_init":{"examples":[{"summary":"Return_draft_order_with_payment_terms[Seller_Collecting]___X13","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_init_ride_provider_accepts_the_terms_of_order_and_appends_its_own_terms_and_responds_with_the_final_draft__2","description":"TBD","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_init_ride_provider_accepts_the_terms_of_order_and_appends_its_own_terms_and_responds_with_the_final_draft__4","description":"TBD","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}]}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"on_rating":{"examples":[{"summary":"Return_acknowledgement_of_rating_and_feedback___X14","value":{"context":{"action":"on_rating","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"2a17e268-1dc4-4d1a-98a2-17554a50c7d2","timestamp":"2023-03-23T05:41:15Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"feedback_ack":true,"rating_ack":true}}}]},"on_search":{"examples":[{"summary":"Return_a_mobility_catalog[Buyer_Collecting]___X16","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BAP"}]}],"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"DELAY_INTEREST"},"value":"5"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"}]}]}}}},{"summary":"Return_a_mobility_catalog[Seller_Collecting]___X15","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"payment_ids":["PA1","PA2"],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"id":"PA1","type":"ON_FULFILLMENT","collected_by":"BPP","status":"NOT_PAID"},{"id":"PA2","type":"POST_CANCELLATION","status":"NOT_PAID","collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_search_ride_providers_which_is_a_mobility_provider_platform_sends_the_catalog_of_all_services_that_can_be_used_for_transit_from_a_to_b_along_with_estimated_fare__1","description":"TBD","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"On Demand"}}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"payments":[{"collected_by":"BPP"}]}]}}}}]},"on_select":{"examples":[{"summary":"Return_a_quote_offered_by_a_provider___X17","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}},{"summary":"on_select_ride_provider_responds_with_detailed_information_and_quote_for_the_specific_service_that_the_buyer_app_would_like_to_avail__2","description":"TBD","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}]}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}]},"on_status":{"examples":[{"summary":"Return_order_with_latest_fulfillment_status_-_Driver_en-route_to_pickup___X19","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP","name":"Driver is en-route to your location"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"PT60M"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"Delivery"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"DELAY_INTEREST"},"value":"2.5"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"174"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}},{"summary":"Return_order_with_latest_status_-_Ride_Ended___X21","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"AUTO_RICKSHAW","make":"Mahindra","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"PT60M"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"Delivery"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"DELAY_INTEREST"},"value":"2.5"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"174"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}},{"summary":"Return_order_with_latest_status_-_Ride_started___X20","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED","name":"Your ride has started"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","params":{"bank_account_number":"xxxxxxxxxxxxxx","bank_code":"XXXXXXXX","virtual_payment_address":"9988199772@okicic"},"status":"NOT_PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"PT60M"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"Delivery"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"DELAY_INTEREST"},"value":"2.5"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"174"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}},{"summary":"Return_order_with_status_-_Driver_at_pickup___X18","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_status_ride_provider_provides_the_latest_update_on_ride_details_to_the_buyer_app_with_fulfillment_state___ride_started_8","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_1","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_10","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"PAID","type":"ON_FULFILLMENT","params":{"amount":"146"}}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_2","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_3","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_4","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_5","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c","amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"}}}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_12","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"on_support":{"examples":[{"summary":"Return_support_information_related_to_an_order___X22","value":{"context":{"action":"on_support","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"support":{"email":"support@nammayatri.in","phone":"+918068870525","url":"https://support.nammayatri.com/gethelp"}}}}]},"on_track":{"examples":[{"summary":"Return_tracking_information_for_an_order___X23","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}]},"on_update":{"examples":[{"summary":"Return_updated_order_with_recomputed_charges___X24","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}},{"summary":"Return_updated_order_with_updated_agent_details___X26","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}},{"summary":"Return_updated_order_with_updated_billing_details___X25","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"email":"jane.doe@example.com","name":"Jane Doe","phone":"+91-9897867564"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"DELAY_INTEREST"},"value":"5"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"P2D"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"DELIVERY"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"1.46"},{"descriptor":{"code":"SETTLEMENT_BANK_CODE"},"value":"XXXXXXXX"},{"descriptor":{"code":"SETTLEMENT_BANK_ACCOUNT_NUMBER"},"value":"xxxxxxxxxxxxxx"},{"descriptor":{"code":"SETTLEMENT_VIRTUAL_PAYMENT_ADDRESS"},"value":"9988199772@okicic"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:53Z","updated_at":"2023-03-23T04:48:53Z"}}}},{"summary":"on_update_ride_provider_provides_the_latest_update_on_ride_details_to_the_buyer_app__7","description":"TBD","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_update_ride_provider_provides_the_updated_order_updates_to_the_buyer_app___can_update_the_quote_in_case_of_fare_update_9","description":"TBD","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"rating":{"examples":[{"summary":"Provide_a_rating___X27","value":{"context":{"action":"rating","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"b462a835-97d6-4479-bec8-9660a0f8513e","timestamp":"2023-03-23T04:46:45Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"id":"b0462745-f6c9-4100-bbe7-4fa3648b6b40","rating_category":"DRIVER","value":4}}},{"summary":"Provide_a_rating_with_feedback_form_data___X28","value":{"context":{"action":"rating","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"849db48a-34c0-454b-86cb-60864482941b","timestamp":"2023-03-23T04:46:45Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"feedback_form":[{"answer":"Driver took me on a route not shown by Google Maps and we reached 10 minutes before time","id":"1"}],"id":"b0462745-f6c9-4100-bbe7-4fa3648b6b40","rating_category":"DRIVER","value":4}}}]},"search":{"examples":[{"summary":"Search_for_mobility_services_by_pickup_and_drop_location[Buyer_Collecting]___X2","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:40:21.452Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"}}}}},{"summary":"Search_for_mobility_services_by_pickup_and_drop_location[Seller_Collecting]___X1","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"select":{"examples":[{"summary":"Get_quote_for_a_specific_product_from_a_mobility_catalog___X3","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}]},"status":{"examples":[{"summary":"Get_latest_fulfillment_status_of_a_booking___X29","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}},{"summary":"status_buyer_app_requests_the_ride_provider_to_provide_the_latest_order_status_4","description":"TBD","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"ref_id":"870782be-6757-43f1-945c-8eeaf9536259"}}}]},"support":{"examples":[{"summary":"Fetch_support_information_related_to_a_particular_order___X30","value":{"context":{"action":"support","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"support":{"ref_id":"7751bd26-3fdc-47ca-9b64-e998dc5abe68"}}}}]},"track":{"examples":[{"summary":"Track_an_active_ride___X31","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}]}}}},"x-attributes":{"on-demand":{"attribute_set":{"search":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"search","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"}},"message":{"intent":{"fulfillment":{"customer":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the customer gender."}}},"agent":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"Describes the type of the stops during the fulfillment of order"},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"12.923608, 77.614629","description":"Describes the GPS co-ordinates of this location."},"address":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2nd & 3rd Floor, 7/6, August Kranti Marg","description":"Describes the address of the location."},"city":{"code":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code."}},"district":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"New Delhi","description":"Describes the district value."},"country":{"code":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"IND","description":"Describes the country code."}},"area_code":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"110049","description":"Describes the area code."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describe the location of the stop"}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"The list of logical stops encountered during the fulfillment of an order."}},"vehicle":{"category":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle category."},"variant":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"OPTIONAL","type":"object","owner":"BAP","usage":"--","description":"Describes a vehicle is a device that is designed or used to transport people or cargo over land, water, air, or through space.
This has properties like category, capacity, make, model, size,variant,color,energy_type,registration"}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"}},"payment":{"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BPP","description":"This field indicates the payment collector. If set to 'bap,' BAP collects first and settles with BPP. If BPP agrees, no payment link is sent. If set to 'bpp,' BPP collects payment directly."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"The terms of settlement for this order"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This helps the system to find out the purpose of the user behind choosing any product or service. By using this intent the system can align relevant options from available products or service."}}}},"on_search":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_search","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"catalog":{"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Mobility Servies BPP","description":"Describes the catalog name."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the catalog's descriptor."}},"providers":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unique Id of the provider."},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"locations":{"id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Indicates provider locations where this item is available."},"gps":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"28.707358, 77.180910","description":"Describes the GPS co-ordinates of this location."},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's locations."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Describes the unique reference ID to the fulfillment of an order"},"customer":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the customer gender."}}},"agent":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."}}},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DELIVERY","description":"A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. "},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"Describes the type of the stops during the fulfillment of order"},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.707358, 77.180910","description":"Describes the GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle category."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"energy_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"CAB","description":"Describes the vehicle energy type."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"}},"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"CAB Economy Ride","description":"Describes the unique code value of the item"},"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the name value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value of price in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value price in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Indicates the locations where this item is available from providers."},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Describes the Unique reference ID for order fulfillment."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"payments":{"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BPP","description":"This field indicates who is the collector of payment. "},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the terms of settlement between the BAP and the BPP for a single transaction"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Denotes settlement amount"}}}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the catalog's description."}}}},"select":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"select","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This decription refers to the comprehensive list of the products or services selected and obtained within the specified order."}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unique Id of the provider."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This describes the complete formulated description of the loan provider whose catalog items have been selected."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the legal contract created between the buyer and the seller."}}}},"on_select":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_select","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the unique code value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value of price in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value of price in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Provider Locations this item is available in"},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unique Id of the provider."},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"DELIVERY","description":"A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. "},"customer":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the customer gender."}}},"agent":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"Describes the type of the stops during the fulfillment of order"},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"Describes the GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle category."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"energy_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"CAB","description":"Describes the vehicle energy type."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency to be paid in of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the order description."}}}},"init":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"init","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This decription refers to the comprehensive list of the products or services selected and obtained within the specified order."}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Id of the provider"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This describes the complete formulated description of the loan provider whose catalog items have been selected."}},"billing":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"John Doe","description":"Name of the billable entity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"The billing details of this order"}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes contact of end-customer"}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes contact of end-customer"}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.707358, 77.180910","description":"The GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes vehicle category"},"variant":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"OPTIONAL","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"}},"payments":{"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Payment status"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Payment Type"},"params":{"bank_code":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the payment params for this order."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"The terms of settlement for this order"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"This refers to the complete description of the legal contract created between the buyer and the seller."}}}},"on_init":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_init","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145-4ea3-45fe-ab3d-7bcf6b9f456b","description":"Describes the unique Id of the item."},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the unique code value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of selected item."},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value of price in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value of price in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Indicates the locations where this item is available from providers."},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unqiue Id of the provider"},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DELIVERY","description":"A code that describes the mode of fulfillment."},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"Describes the GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle category."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"energy_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"CAB","description":"Describes the vehicle energy type."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Describes the name of the customer"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Describes the contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"}}},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency to be paid in of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the price of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Describes the ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Describe the payment Status for particular order"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Describe the payment type for particular order"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the payment params for this order."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"The terms of settlement for this order"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."},"id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."}}}},"confirm":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"confirm","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This decription refers to the comprehensive list of the products or services selected and obtained within the specified order."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the uique Id of the provider."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This describes the complete formulated description of the loan provider whose catalog items have been selected."}},"billing":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"John Doe","description":"Describes the Name of the billable entity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"The billing details of this order"}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"bc08edb1","description":"ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Describe the payment Status for particular order"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Describe the payment type for particular order"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"transaction_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"cda41144","description":"Describes transaction ID associated with payment activity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the payment params for this order."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"The terms of settlement for this order"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Describe the name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes contact of end-customer"}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Describe the contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes contact of end-customer"}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"Describes the type of the stops during the fulfillment of order"},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"The GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes vehicle category"},"variant":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"OPTIONAL","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"This refers to the complete description of the legal contract created between the buyer and the seller."},"id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."}}}},"on_confirm":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_confirm","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Single Journey Ticket","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"SJT","description":"Describes the unique code value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type to be paid in of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Indicates the locations where this item is available from providers."},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"P1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Unique reference ID to the payment of an order"},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"P1","description":"Unique reference ID to the payment of an order"},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Describes the name of the customer"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Describes the contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"John Doe","description":"Describes the name of the agent"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"},"image":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/images","description":"Describes the agent image"},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the size type of image"}},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the agent details."}},"rating":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"5","description":"Describes the agent rating."},"contact":{"phone":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":7845981268,"description":"Describes the contact number of the agent"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent."}},"state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ASSIGNED","description":"Describes the state's code for fulfillment."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the fulfillments description."}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"INTERMEDIATE_STOP","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.707358, 77.180910","description":"The GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"authorization":{"type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"OTP","description":"Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy."},"token":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":232312,"description":"Token used for authorization. This is typically generated at the BPP. The BAP can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering."},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the authorization for a fulfillments stop."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"AUTO_RICKSHAW","description":"Describes vehicle category"},"make":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Bajaj","description":"Describes vehicle manufacturer"},"model":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"compact-re","description":"Describes vehicle model"},"registration":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"HR-20AS-4578","description":"Describes vehicle registration details"},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency to be paid in of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Describes the ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Describe the Payment Status"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Describe the Payment type"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"amount":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":146,"description":"Describes the amount associated with the payment transaction"},"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency associated with the payment transaction"},"transaction_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"cda41144","description":"Describes transaction ID associated with payment activity"}},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"status":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ACTIVE","description":"Describes the order status."},"created_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes the date-time of creation of this order"},"updated_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes The date-time of updated of this order"},"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."}}}},"cancel":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"cancel","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"60253df1","description":"Describes the unique ID of the order. "},"cancellation_reason_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"45dd6fd3","description":"Describes the reason Id for cancellation"},"descriptor":{"short_desc":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"Accidantaly book the ride","description":"Describes the Short description for cancellaion"},"name":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"Ride Cancellation","description":"Describes the name for cancellaion"},"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"SOFT_CANCEL","description":"Describes the code for cancellaion"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This include the details about the distinctive features, benefits, or unique aspects of the products or service that has been offered to the end customer."}}}},"on_cancel":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_cancel","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique ID of the order. "},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the unique code value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Describes the unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Describes the unique reference ID to the payment of an order"},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Provider Locations this item is available in"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type to be paid in of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unique ID of the provider."},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"Describes a GPS coordinate"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"authorization":{"type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"OTP","description":"Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy."},"token":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":232312,"description":"Token used for authorization. This is typically generated at the BPP. The BAP can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering."}},"time":{"duration":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"PT2H","description":"Describes the duration."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the fulfillments stops."}},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"John Doe","description":"Describes the name of the agent"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"},"image":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/images","description":"Describes the agent image"},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the size type of image"}},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the agent details."}},"rating":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"5","description":"Describes the agent rating."},"contact":{"phone":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":7845981268,"description":"Describes the contact number of the agent"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent."}},"vehicle":{"registration":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"HR-20AS-4578","description":"Describes vehicle registration details"},"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"AUTO_RICKSHAW","description":"Describes vehicle category"},"make":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Bajaj","description":"Describes vehicle manufacturer"},"model":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"compact-re","description":"Describes vehicle model"},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the vehicle type."}},"state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DRIVER_ENROUTE","description":"Describes the state's code for fulfillment."},"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Driver is on the way","description":"Describes the current state"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the fulfillments description."}}},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"P1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Describes the Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency type of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"ID of the payment term that can be referred at an item or an order level in a catalog"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Describe the Payment type"},"params":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes currency value in string form"},"amount":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":60,"description":"Describes a numerical value in decimal form"},"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"bank_account_name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Raghvinder J","description":"Describes the Bank account holder name"},"virtual_payment_address":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"}},"time":{"duration":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P1D","description":"Describes time transaction duration"}},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Describe the Payment Status"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."},"status":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"SOFT_CANCEL","description":"Describes the order status."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."},"documents":{"descriptor":{"code":{"required":"OPTIONAL","usage":"INVOICE","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"string"},"name":{"required":"OPTIONAL","usage":"Invoice Document","description":"It refers to the specific name of the document","owner":"BPP","type":"string"},"short_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the concised description of the document","owner":"BPP","type":"string"},"long_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the brief description of the document","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"object"}},"mime_type":{"required":"OPTIONAL","usage":"application/pdf","description":"It refers to the categorization of the document based on its file format and content type.","owner":"BPP","type":"string"},"url":{"required":"OPTIONAL","usage":"https://seller.com/loan/invoice/O1.pdf","description":"This describes the url from where the document can be accessed","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the set of documents that are associated to a particular order","owner":"BPP","type":"object"}}}}},"status":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"status","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"60253df1","description":"Describes the unique ID of the order. "},"ref_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"60253df1","description":"Describes unique id for reference, pre-order this will be transaction ID."}}},"on_status":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_status","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique ID of the item. "},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the item code."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes a numerical value in decimal form"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Provider Locations this item is available in"},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Id of the provider"},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"28.686576, 77.441632","description":"Describes a GPS coordinate"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"CAB","description":"Describes vehicle category"},"make":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Bajaj","description":"Describes vehicle manufacturer"},"model":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"compact-re","description":"Describes vehicle model"},"registration":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"HR-20AS-4578","description":"Describes vehicle registration details"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the vehicle type."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."}},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Jason Roy","description":"Name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BPP","usage":9898657512,"description":"Contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"John Doe","description":"Describes the name of the agent"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"},"image":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/images","description":"Describes the agent image"},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the size type of image"}},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the agent details."}},"rating":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"5","description":"Describes the agent rating."},"contact":{"phone":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":7845981268,"description":"Describes the contact number of the agent"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent."}},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Delivery","description":"Describes type of fullfilment"},"state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DRIVER_ENROUTE","description":"Describes the state's code for fulfillment."},"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Driver is on the way","description":"Describes the current state"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the fulfillments description."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency to be paid in of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"PA1","description":"ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Payment Status"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Payment type"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"transaction_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"cda41144","description":"Describes transaction ID associated with payment activity"},"amount":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":146,"description":"Describes the amount associated with the payment transaction"},"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency associated with the payment transaction"}},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"status":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"ACTIVE","description":"Describes the order status."},"created_at":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes the date-time of creation of this order"},"updated_at":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes The date-time of updated of this order"},"id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."},"documents":{"descriptor":{"code":{"required":"OPTIONAL","usage":"INVOICE","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"string"},"name":{"required":"OPTIONAL","usage":"Invoice Document","description":"It refers to the specific name of the document","owner":"BPP","type":"string"},"short_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the concised description of the document","owner":"BPP","type":"string"},"long_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the brief description of the document","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"object"}},"mime_type":{"required":"OPTIONAL","usage":"application/pdf","description":"It refers to the categorization of the document based on its file format and content type.","owner":"BPP","type":"string"},"url":{"required":"OPTIONAL","usage":"https://seller.com/loan/invoice/O1.pdf","description":"This describes the url from where the document can be accessed","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the set of documents that are associated to a particular order","owner":"BPP","type":"object"}}}}},"update":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_status","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":1,"description":"Describes the unique order id"},"fulfillments":{"customer":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"John Adam","description":"Name of the customer"}}},"_description":{"required":"OPTIONAL","type":"object","owner":"BAP/BPP","usage":"--","description":"Name of the customer"}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the unique order id"}}}},"on_update":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_update","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique ID of the item. "},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name. "},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the item code. "},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes a numerical value in decimal form"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Provider Locations this item is available in"},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Id of the provider"},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"Describes a GPS coordinate"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the location of stops."}},"authorization":{"type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"OTP","description":"Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy."},"token":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":232312,"description":"Token used for authorization. This is typically generated at the BPP. The BAP can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering."},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the authorization for a fulfillments stop."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes vehicle category"},"make":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Bajaj","description":"Describes vehicle manufacturer"},"model":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"compact-re","description":"Describes vehicle model"},"registration":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"HR-20AS-4578","description":"Describes vehicle registration details"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."}},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"John Adam","description":"Name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"John Doe","description":"Describes the name of the agent"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"},"image":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/images","description":"Describes the agent image"},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the size type of image"}},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the agent details."}},"rating":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"5","description":"Describes the agent rating."},"contact":{"phone":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":7845981268,"description":"Describes the contact number of the agent"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent."}},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Delivery","description":"Describes type of fullfilment"},"state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DRIVER_ENROUTE","description":"Describes the state's code for fulfillment."},"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Driver is on the way","description":"Describes the current state"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the fulfillments description."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency to be paid in of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"PA1","description":"ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Payment Status"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Payment type"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"}},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"status":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"COMPLETED","description":"Describes the order status."},"created_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes the date-time of creation of this order"},"updated_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes The date-time of updated of this order"},"billing":{"name":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"John Doe","description":"Describes the Name of the billable entity"},"email":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"jane.doe@example.com","description":"Describes the email of the billable entity"},"phone":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":9897867564,"description":"Describes the contact number of the billable entity"}},"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."},"documents":{"descriptor":{"code":{"required":"OPTIONAL","usage":"INVOICE","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"string"},"name":{"required":"OPTIONAL","usage":"Invoice Document","description":"It refers to the specific name of the document","owner":"BPP","type":"string"},"short_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the concised description of the document","owner":"BPP","type":"string"},"long_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the brief description of the document","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"object"}},"mime_type":{"required":"OPTIONAL","usage":"application/pdf","description":"It refers to the categorization of the document based on its file format and content type.","owner":"BPP","type":"string"},"url":{"required":"OPTIONAL","usage":"https://seller.com/loan/invoice/O1.pdf","description":"This describes the url from where the document can be accessed","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the set of documents that are associated to a particular order","owner":"BPP","type":"object"}}}}},"track":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"track","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"O1","description":"Describes the order ID."}}},"on_track":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_track","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"tracking":{"status":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"O1","description":"Describes the order status."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"28.620976, 77.046732","description":"Describes the gps value."},"updated_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-03-23T05:41:09Z","description":"Describes the updated_at value."}}}}}}}},"x-errorcodes":{"code":[{"Event":"Route Serviceability error","Description":"To & from location not serviceable by Seller application","From":"BPP","code":90201},{"Event":"Tracking not enabled","Description":"Tracking not enabled for any fulfillment in the order","From":"BPP","code":90202},{"Event":"Driver not assigned","Description":"Driver not assigned to the order","From":"BPP","code":90203}]},"x-tlc":{"code":[{"Term":"Payment Collector ","Api":"search/on_search/init/on_init\t","Attribute":"payment.collected_by ","Owner":"Either","Value":"“BAP”, “BPP” ","Description":"If set to “BAP”, it means that the Buyer App will collect payment from the Buyer.\nIf set to “BPP”, it means that the Seller App will collect payment from the Buyer."},{"Term":"Payment Type ","Api":"init/on_init ","Attribute":"payment.type ","Owner":"Either","Value":"“ON-ORDER”, “ON_FULFILLMENT”\n","Description":"How payment is going to be collected from the Buyer. If this parameter is set to “ON-ORDER”, that means it is a pre-paid order, i.e. the payment is collected at the time of order confirmation. If this parameter is set to “ON_FULFILLMENT”, that means it is a pay at the end of the trip, i.e. the payment is collected when the trip ends."},{"Term":"Item Cancellability ","Api":"search/on_search/init/on_init\t","Attribute":"Handled in cancellation terms ","Owner":"Seller App\t","Value":"true/ false\t","Description":"Whether the order for that item can be canceled after being confirmed. If set to “TRUE” that means the Seller allows the Buyer to cancel the order for the item in question, after confirmation."},{"Term":"Static Terms","Api":"search/on_search/init/on_init\t","Attribute":"STATIC_TERMS","Owner":"Seller App & Buyer App","Value":"URL","Description":"This will be the URL of a web-page where the standard Terms and Conditions of the Network Participant - which are not covered in the API Specification (e.g.: indemnity) - will be hosted. These terms will apply to the transaction, in addition to the terms decided through the ONDC Protocol. If there is a conflict between the terms decided through the Protocol, and the Static Terms, the terms decided through the ONDC Protocol will prevail. Also, if there is a conflict between the Static Terms and the ONDC Network Policy or the Static Terms and the Network Participant Agreement, the terms of the ONDC Network Policy or the Network Participant Agreement (as the case may be) will prevail."}]},"x-featureui":{"filenames":["document_sharing.md"]},"x-sandboxui":{"dropdown":[{"environment-name":"staging","link":"https://mobility-staging.ondc.org"}]},"x-changeLog":{"filenames":["TRV10_2.1.0_030924.md"]}} \ No newline at end of file +let build_spec = {"openapi":"3.0.0","info":{"title":"ONDC Specification","description":"ONDC Specification","version":"2.0.0"},"security":[{"SubscriberAuth":[]}],"paths":{"/search":{"post":{"tags":["Provider Platform","Gateway"],"description":"Consumer Platform declares the customer's intent to buy/avail products or services","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"properties":{"action":{"enum":["search"]}}}]},"message":{"type":"object","additionalProperties":false,"properties":{"intent":{"$ref":"#/components/schemas/Intent"}}}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/select":{"post":{"tags":["Provider Platform"],"description":"Consumer Platform declares the customer's cart (or equivalent) created by selecting objects from the catalog","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["select"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/init":{"post":{"tags":["Provider Platform"],"description":"Initialize an order by providing billing and/or shipping details","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["init"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]}},"required":["context","message"]}}}},"responses":{"default":{"description":"Acknowledgement of message received after successful validation of schema and signature","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"object","properties":{"ack":{"allOf":[{"$ref":"#/components/schemas/Ack"},{"type":"object"},{"properties":{"status":{"enum":["ACK","NACK"]}}}]}},"required":["ack"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["message"]}}}}}}},"/confirm":{"post":{"tags":["Provider Platform"],"description":"Initialize an order by providing billing and/or shipping details","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["confirm"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/status":{"post":{"tags":["Provider Platform"],"description":"Fetch the latest order object","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["status"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"ref_id":{"$ref":"#/components/schemas/Order/properties/id"},"order_id":{"$ref":"#/components/schemas/Order/properties/id"}}}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/track":{"post":{"tags":["Provider Platform"],"description":"Track an active order","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["track"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order_id":{"$ref":"#/components/schemas/Order/properties/id"},"callback_url":{"type":"string","format":"uri"}},"required":["order_id"]}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/cancel":{"post":{"tags":["Provider Platform"],"description":"Cancel an order","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["cancel"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order_id":{"$ref":"#/components/schemas/Order/properties/id"},"cancellation_reason_id":{"$ref":"#/components/schemas/Option/properties/id"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"cancellation":{"description":"The cancellation details of this order","allOf":[{"$ref":"#/components/schemas/Cancellation"}]}},"required":["order_id"]}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/update":{"post":{"tags":["Provider Platform"],"description":"Remove object","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["update"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"update_target":{"description":"Comma separated values of order objects being updated. For example: ```\"update_target\":\"item,billing,fulfillment\"```","type":"string"},"order":{"description":"Updated order object","allOf":[{"$ref":"#/components/schemas/Order"}]}},"required":["update_target","order"]}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/rating":{"post":{"tags":["Provider Platform"],"description":"Provide feedback on a service","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["rating"]}},"required":["action"]}]},"message":{"type":"object","properties":{"order_id":{"$ref":"#/components/schemas/Order/properties/id"},"ratings":{"type":"array","items":{"$ref":"#/components/schemas/Rating"}}}}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/support":{"post":{"tags":["Provider Platform"],"description":"Contact support","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["support"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"support":{"$ref":"#/components/schemas/Support"}}}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_search":{"post":{"tags":["Consumer Platform"],"description":"Provider Platform sends its catalog in response to a search request.","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_search"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"catalog":{"$ref":"#/components/schemas/Catalog"}},"required":["catalog"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_select":{"post":{"tags":["Consumer Platform"],"description":"Send draft order object with quoted price for selected items","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_select"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}}},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_init":{"post":{"tags":["Consumer Platform"],"description":"Send order object with payment details updated","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_init"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_confirm":{"post":{"tags":["Consumer Platform"],"description":"Send active order object","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_confirm"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_track":{"post":{"tags":["Consumer Platform"],"description":"Send tracking details of an active order","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_track"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"tracking":{"$ref":"#/components/schemas/Tracking"}},"required":["tracking"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_cancel":{"post":{"tags":["Consumer Platform"],"description":"Send cancellation request_id with reasons list in case of cancellation request. Else send cancelled order object","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_cancel"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_update":{"post":{"tags":["Consumer Platform"],"description":"Returns updated service with updated runtime object","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_update"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_status":{"post":{"tags":["Consumer Platform"],"description":"Fetch the status of a Service","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_status"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_rating":{"post":{"tags":["Consumer Platform"],"description":"Provide feedback on a service","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_rating"]}},"required":["action"]}]},"message":{"type":"object","properties":{"order_id":{"$ref":"#/components/schemas/Order/properties/id"},"ratings":{"type":"array","items":{"$ref":"#/components/schemas/Rating"}}}},"error":{"$ref":"#/components/schemas/Error"}},"required":["context"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_support":{"post":{"tags":["Consumer Platform"],"description":"Contact Support","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_support"]}},"required":["action"]}]},"message":{"type":"object","properties":{"support":{"$ref":"#/components/schemas/Support"}}},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}}},"components":{"securitySchemes":{"SubscriberAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Signature of message body using Consumer Platform or Provider Platform subscriber's signing public key.

Format:

Authorization : Signature keyId=\"{subscriber_id}|{unique_key_id}|{algorithm}\",algorithm=\"ed25519\",created=\"1606970629\",expires=\"1607030629\",headers=\"(created) (expires) digest\",signature=\"Base64(signing string)\""}},"schemas":{"Ack":{"description":"Describes the acknowledgement sent in response to an API call. If the implementation uses HTTP/S, then Ack must be returned in the same session. Every API call to a BPP must be responded to with an Ack whether the BPP intends to respond with a callback or not. This has one property called `status` that indicates the status of the Acknowledgement.","type":"object","additionalProperties":false,"properties":{"status":{"type":"string","description":"The status of the acknowledgement. If the request passes the validation criteria of the BPP, then this is set to ACK. If a BPP responds with status = `ACK` to a request, it is required to respond with a callback. If the request fails the validation criteria, then this is set to NACK. Additionally, if a BPP does not intend to respond with a callback even after the request meets the validation criteria, it should set this value to `NACK`.","enum":["ACK","NACK"]},"tags":{"description":"A list of tags containing any additional information sent along with the Acknowledgement.","type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"AddOn":{"description":"Describes an additional item offered as a value-addition to a product or service. This does not exist independently in a catalog and is always associated with an item.","type":"object","additionalProperties":false,"properties":{"id":{"description":"Provider-defined ID of the add-on","type":"string"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"price":{"$ref":"#/components/schemas/Price"},"quantity":{"$ref":"#/components/schemas/ItemQuantity"}}},"Address":{"description":"Describes a postal address.","type":"string"},"Agent":{"description":"Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the BPP wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.","type":"object","additionalProperties":false,"properties":{"person":{"$ref":"#/components/schemas/Person"},"contact":{"$ref":"#/components/schemas/Contact"},"organization":{"$ref":"#/components/schemas/Organization"},"rating":{"$ref":"#/components/schemas/Rating/properties/value"}}},"Authorization":{"description":"Describes an authorization mechanism used to start or end the fulfillment of an order. For example, in the mobility sector, the driver may require a one-time password to initiate the ride. In the healthcare sector, a patient may need to provide a password to open a video conference link during a teleconsultation.","type":"object","additionalProperties":false,"properties":{"type":{"description":"Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy.","type":"string"},"token":{"description":"Token used for authorization. This is typically generated at the BPP. The BAP can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering.","type":"string"},"valid_from":{"description":"Timestamp in RFC3339 format from which token is valid","type":"string","format":"date-time"},"valid_to":{"description":"Timestamp in RFC3339 format until which token is valid","type":"string","format":"date-time"},"status":{"description":"Status of the token","type":"string"}}},"Billing":{"description":"Describes the billing details of an entity.
This has properties like name,organization,address,email,phone,time,tax_number, created_at,updated_at","type":"object","additionalProperties":false,"properties":{"name":{"description":"Name of the billable entity","type":"string"},"organization":{"description":"Details of the organization being billed.","allOf":[{"$ref":"#/components/schemas/Organization"}]},"address":{"description":"The address of the billable entity","allOf":[{"$ref":"#/components/schemas/Address"}]},"state":{"description":"The state where the billable entity resides. This is important for state-level tax calculation","allOf":[{"$ref":"#/components/schemas/State"}]},"city":{"description":"The city where the billable entity resides.","allOf":[{"$ref":"#/components/schemas/City"}]},"email":{"description":"Email address where the bill is sent to","type":"string","format":"email"},"phone":{"description":"Phone number of the billable entity","type":"string"},"time":{"description":"Details regarding the billing period","allOf":[{"$ref":"#/components/schemas/Time"}]},"tax_id":{"description":"ID of the billable entity as recognized by the taxation authority","type":"string"}}},"Cancellation":{"description":"Describes a cancellation event","type":"object","additionalProperties":false,"properties":{"time":{"description":"Date-time when the order was cancelled by the buyer","type":"string","format":"date-time"},"cancelled_by":{"type":"string","enum":["CONSUMER","PROVIDER"]},"reason":{"description":"The reason for cancellation","allOf":[{"$ref":"#/components/schemas/Option"}]},"additional_description":{"description":"Any additional information regarding the nature of cancellation","allOf":[{"$ref":"#/components/schemas/Descriptor"}]}}},"CancellationTerm":{"description":"Describes the cancellation terms of an item or an order. This can be referenced at an item or order level. Item-level cancellation terms can override the terms at the order level.","type":"object","additionalProperties":false,"properties":{"fulfillment_state":{"description":"The state of fulfillment during which this term is applicable.","allOf":[{"$ref":"#/components/schemas/FulfillmentState"}]},"reason_required":{"description":"Indicates whether a reason is required to cancel the order","type":"boolean"},"cancel_by":{"description":"Information related to the time of cancellation.","allOf":[{"$ref":"#/components/schemas/Time"}]},"cancellation_fee":{"$ref":"#/components/schemas/Fee"},"xinput":{"$ref":"#/components/schemas/XInput"},"external_ref":{"$ref":"#/components/schemas/MediaFile"},"cancellation_eligible":{"description":"Indicates if cancellation is eligible","type":"boolean"}}},"Catalog":{"description":"Describes the products or services offered by a BPP. This is typically sent as the response to a search intent from a BAP. The payment terms, offers and terms of fulfillment supported by the BPP can also be included here. The BPP can show hierarchical nature of products/services in its catalog using the parent_category_id in categories. The BPP can also send a ttl (time to live) in the context which is the duration for which a BAP can cache the catalog and use the cached catalog.
This has properties like bbp/descriptor,bbp/categories,bbp/fulfillments,bbp/payments,bbp/offers,bbp/providers and exp
This is used in the following situations.
  • This is typically used in the discovery stage when the BPP sends the details of the products and services it offers as response to a search intent from the BAP.
","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"fulfillments":{"description":"Fulfillment modes offered at the BPP level. This is used when a BPP itself offers fulfillments on behalf of the providers it has onboarded.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment"}},"payments":{"description":"Payment terms offered by the BPP for all transactions. This can be overriden at the provider level.","type":"array","items":{"$ref":"#/components/schemas/Payment"}},"offers":{"description":"Offers at the BPP-level. This is common across all providers onboarded by the BPP.","type":"array","items":{"$ref":"#/components/schemas/Offer"}},"providers":{"type":"array","items":{"$ref":"#/components/schemas/Provider"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}},"exp":{"description":"Timestamp after which catalog will expire","type":"string","format":"date-time"},"ttl":{"description":"Duration in seconds after which this catalog will expire","type":"string"}}},"Category":{"description":"A label under which a collection of items can be grouped.","type":"object","additionalProperties":false,"properties":{"id":{"description":"ID of the category","type":"string"},"parent_category_id":{"$ref":"#/components/schemas/Category/properties/id"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"time":{"$ref":"#/components/schemas/Time"},"ttl":{"description":"Time to live for an instance of this schema"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"Circle":{"description":"Describes a circular region of a specified radius centered at a specified GPS coordinate.","type":"object","additionalProperties":false,"properties":{"gps":{"$ref":"#/components/schemas/Gps"},"radius":{"$ref":"#/components/schemas/Scalar"}}},"City":{"description":"Describes a city","type":"object","additionalProperties":false,"properties":{"name":{"description":"Name of the city","type":"string"},"code":{"description":"City code","type":"string"}}},"Contact":{"description":"Describes the contact information of an entity","type":"object","additionalProperties":false,"properties":{"phone":{"type":"string"},"email":{"type":"string"},"jcard":{"type":"object","additionalProperties":false,"description":"A Jcard object as per draft-ietf-jcardcal-jcard-03 specification"}}},"Context":{"description":"Every API call in beckn protocol has a context. It provides a high-level overview to the receiver about the nature of the intended transaction. Typically, it is the BAP that sets the transaction context based on the consumer's location and action on their UI. But sometimes, during unsolicited callbacks, the BPP also sets the transaction context but it is usually the same as the context of a previous full-cycle, request-callback interaction between the BAP and the BPP. The context object contains four types of fields.
  1. Demographic information about the transaction using fields like `domain`, `country`, and `region`.
  2. Addressing details like the sending and receiving platform's ID and API URL.
  3. Interoperability information like the protocol version that implemented by the sender and,
  4. Transaction details like the method being called at the receiver's endpoint, the transaction_id that represents an end-to-end user session at the BAP, a message ID to pair requests with callbacks, a timestamp to capture sending times, a ttl to specifiy the validity of the request, and a key to encrypt information if necessary.
This object must be passed in every interaction between a BAP and a BPP. In HTTP/S implementations, it is not necessary to send the context during the synchronous response. However, in asynchronous protocols, the context must be sent during all interactions,","type":"object","additionalProperties":false,"properties":{"domain":{"description":"Domain code that is relevant to this transaction context","allOf":[{"$ref":"#/components/schemas/Domain/properties/code","type":"string"}]},"location":{"description":"The location where the transaction is intended to be fulfilled.","allOf":[{"$ref":"#/components/schemas/Location"}]},"action":{"description":"The Beckn protocol method being called by the sender and executed at the receiver.","type":"string"},"version":{"type":"string","description":"Version of transaction protocol being used by the sender."},"bap_id":{"description":"Subscriber ID of the BAP","allOf":[{"description":"A globally unique identifier of the platform, Typically it is the fully qualified domain name (FQDN) of the platform.","type":"string"}]},"bap_uri":{"description":"Subscriber URL of the BAP for accepting callbacks from BPPs.","allOf":[{"description":"The callback URL of the Subscriber. This should necessarily contain the same domain name as set in `subscriber_id``.","type":"string","format":"uri"}]},"bpp_id":{"description":"Subscriber ID of the BPP","allOf":[{"$ref":"#/components/schemas/Context/properties/bap_id/allOf/0"}]},"bpp_uri":{"description":"Subscriber URL of the BPP for accepting calls from BAPs.","allOf":[{"$ref":"#/components/schemas/Context/properties/bap_uri/allOf/0"}]},"transaction_id":{"description":"This is a unique value which persists across all API calls from `search` through `confirm`. This is done to indicate an active user session across multiple requests. The BPPs can use this value to push personalized recommendations, and dynamic offerings related to an ongoing transaction despite being unaware of the user active on the BAP.","type":"string","format":"uuid"},"message_id":{"description":"This is a unique value which persists during a request / callback cycle. Since beckn protocol APIs are asynchronous, BAPs need a common value to match an incoming callback from a BPP to an earlier call. This value can also be used to ignore duplicate messages coming from the BPP. It is recommended to generate a fresh message_id for every new interaction. When sending unsolicited callbacks, BPPs must generate a new message_id.","type":"string","format":"uuid"},"timestamp":{"description":"Time of request generation in RFC3339 format","type":"string","format":"date-time"},"key":{"description":"The encryption public key of the sender","type":"string"},"ttl":{"description":"The duration in ISO8601 format after timestamp for which this message holds valid","type":"string"}}},"Country":{"description":"Describes a country","type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the country"},"code":{"type":"string","description":"Country code as per ISO 3166-1 and ISO 3166-2 format"}}},"Credential":{"description":"Describes a credential of an entity - Person or Organization","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","default":"VerifiableCredential"},"url":{"description":"URL of the credential","type":"string","format":"uri"}}},"Customer":{"description":"Describes a customer buying/availing a product or a service","type":"object","additionalProperties":false,"properties":{"person":{"$ref":"#/components/schemas/Person"},"contact":{"$ref":"#/components/schemas/Contact"}}},"DecimalValue":{"description":"Describes a numerical value in decimal form","type":"string","pattern":"[+-]?([0-9]*[.])?[0-9]+"},"Descriptor":{"description":"Physical description of something.","type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"code":{"type":"string"},"short_desc":{"type":"string"},"long_desc":{"type":"string"},"additional_desc":{"type":"object","additionalProperties":false,"properties":{"url":{"type":"string"},"content_type":{"type":"string","enum":["text/plain","text/html","application/json"]}}},"media":{"type":"array","items":{"$ref":"#/components/schemas/MediaFile"}},"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"}}}},"Domain":{"description":"Described the industry sector or sub-sector. The network policy should contain codes for all the industry sectors supported by the network. Domains can be created in varying levels of granularity. The granularity of a domain can be decided by the participants of the network. Too broad domains will result in irrelevant search broadcast calls to BPPs that don't have services supporting the domain. Too narrow domains will result in a large number of registry entries for each BPP. It is recommended that network facilitators actively collaborate with various working groups and network participants to carefully choose domain codes keeping in mind relevance, performance, and opportunity cost. It is recommended that networks choose broad domains like mobility, logistics, healthcare etc, and progressively granularize them as and when the number of network participants for each domain grows large.","type":"object","additionalProperties":false,"properties":{"name":{"description":"Name of the domain","type":"string"},"code":{"description":"Standard code representing the domain. The standard is usually published as part of the network policy. Furthermore, the network facilitator should also provide a mechanism to provide the supported domains of a network."},"additional_info":{"description":"A url that contains addtional information about that domain.","allOf":[{"$ref":"#/components/schemas/MediaFile"}]}}},"Duration":{"description":"Describes duration as per ISO8601 format","type":"string"},"Error":{"description":"Describes an error object that is returned by a BAP, BPP or BG as a response or callback to an action by another network participant. This object is sent when any request received by a network participant is unacceptable. This object can be sent either during Ack or with the callback.","type":"object","additionalProperties":false,"properties":{"code":{"type":"string","description":"Standard error code. For full list of error codes, refer to docs/protocol-drafts/BECKN-005-ERROR-CODES-DRAFT-01.md of this repo\""},"paths":{"type":"string","description":"Path to json schema generating the error. Used only during json schema validation errors"},"message":{"type":"string","description":"Human readable message describing the error. Used mainly for logging. Not recommended to be shown to the user."}}},"Fee":{"description":"A fee applied on a particular entity","type":"object","additionalProperties":false,"properties":{"percentage":{"description":"Percentage of a value","allOf":[{"$ref":"#/components/schemas/DecimalValue"}]},"amount":{"description":"A fixed value","allOf":[{"$ref":"#/components/schemas/Price"}]}}},"Form":{"description":"Describes a form","type":"object","additionalProperties":false,"properties":{"id":{"description":"The form identifier.","type":"string"},"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.","type":"string","format":"uri"},"data":{"description":"The form submission data","type":"object","additionalProperties":true},"mime_type":{"description":"This field indicates the nature and format of the form received by querying the url. MIME types are defined and standardized in IETF's RFC 6838.","type":"string","enum":["text/html","application/html","application/xml","none"]},"resubmit":{"type":"boolean"},"multiple_submissions":{"type":"boolean"}}},"Fulfillment":{"description":"Describes how a an order will be rendered/fulfilled to the end-customer","type":"object","additionalProperties":false,"properties":{"id":{"description":"Unique reference ID to the fulfillment of an order","type":"string"},"type":{"description":"A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. For example, a retail order can be fulfilled either via store pickup or a home delivery. Similarly, a medical consultation can be provided either in-person or via tele-consultation. The network policy must publish standard fulfillment type codes for the different modes of fulfillment.","type":"string"},"rateable":{"description":"Whether the fulfillment can be rated or not","type":"boolean"},"rating":{"description":"The rating value of the fulfullment service.","allOf":[{"$ref":"#/components/schemas/Rating/properties/value"}]},"state":{"description":"The current state of fulfillment. The BPP must set this value whenever the state of the order fulfillment changes and fire an unsolicited `on_status` call.","allOf":[{"$ref":"#/components/schemas/FulfillmentState"}]},"tracking":{"type":"boolean","description":"Indicates whether the fulfillment allows tracking","default":false},"customer":{"description":"The person that will ultimately receive the order","allOf":[{"$ref":"#/components/schemas/Customer"}]},"agent":{"description":"The agent that is currently handling the fulfillment of the order","allOf":[{"$ref":"#/components/schemas/Agent"}]},"contact":{"$ref":"#/components/schemas/Contact"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"stops":{"description":"The list of logical stops encountered during the fulfillment of an order.","type":"array","items":{"$ref":"#/components/schemas/Stop"}},"path":{"description":"The physical path taken by the agent that can be rendered on a map. The allowed format of this property can be set by the network.","type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"FulfillmentState":{"description":"Describes the state of fulfillment","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string","description":"ID of entity which changed the state"}}},"Gps":{"description":"Describes a GPS coordinate","type":"string","pattern":"^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?),\\s*[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$"},"Image":{"description":"Describes an image","type":"object","additionalProperties":false,"properties":{"url":{"description":"URL to the image. This can be a data url or an remote url","type":"string","format":"uri"},"size_type":{"description":"The size of the image. The network policy can define the default dimensions of each type","type":"string","enum":["xs","sm","md","lg","xl","custom"]},"width":{"description":"Width of the image in pixels","type":"string"},"height":{"description":"Height of the image in pixels","type":"string"}}},"Intent":{"description":"The intent to buy or avail a product or a service. The BAP can declare the intent of the consumer containing
  • What they want (A product, service, offer)
  • Who they want (A seller, service provider, agent etc)
  • Where they want it and where they want it from
  • When they want it (start and end time of fulfillment
  • How they want to pay for it

This has properties like descriptor,provider,fulfillment,payment,category,offer,item,tags
This is typically used by the BAP to send the purpose of the user's search to the BPP. This will be used by the BPP to find products or services it offers that may match the user's intent.
For example, in Mobility, the mobility consumer declares a mobility intent. In this case, the mobility consumer declares information that describes various aspects of their journey like,
  • Where would they like to begin their journey (intent.fulfillment.start.location)
  • Where would they like to end their journey (intent.fulfillment.end.location)
  • When would they like to begin their journey (intent.fulfillment.start.time)
  • When would they like to end their journey (intent.fulfillment.end.time)
  • Who is the transport service provider they would like to avail services from (intent.provider)
  • Who is traveling (This is not recommended in public networks) (intent.fulfillment.customer)
  • What kind of fare product would they like to purchase (intent.item)
  • What add-on services would they like to avail
  • What offers would they like to apply on their booking (intent.offer)
  • What category of services would they like to avail (intent.category)
  • What additional luggage are they carrying
  • How would they like to pay for their journey (intent.payment)

For example, in health domain, a consumer declares the intent for a lab booking the describes various aspects of their booking like,
  • Where would they like to get their scan/test done (intent.fulfillment.start.location)
  • When would they like to get their scan/test done (intent.fulfillment.start.time)
  • When would they like to get the results of their test/scan (intent.fulfillment.end.time)
  • Who is the service provider they would like to avail services from (intent.provider)
  • Who is getting the test/scan (intent.fulfillment.customer)
  • What kind of test/scan would they like to purchase (intent.item)
  • What category of services would they like to avail (intent.category)
  • How would they like to pay for their journey (intent.payment)
","type":"object","additionalProperties":false,"properties":{"descriptor":{"description":"A raw description of the search intent. Free text search strings, raw audio, etc can be sent in this object.","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"provider":{"description":"The provider from which the customer wants to place to the order from","allOf":[{"$ref":"#/components/schemas/Provider"}]},"fulfillment":{"description":"Details on how the customer wants their order fulfilled","allOf":[{"$ref":"#/components/schemas/Fulfillment"}]},"payment":{"description":"Details on how the customer wants to pay for the order","allOf":[{"$ref":"#/components/schemas/Payment"}]},"category":{"description":"Details on the item category","allOf":[{"$ref":"#/components/schemas/Category"}]},"offer":{"description":"details on the offer the customer wants to avail","allOf":[{"$ref":"#/components/schemas/Offer"}]},"item":{"description":"Details of the item that the consumer wants to order","allOf":[{"$ref":"#/components/schemas/Item"}]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"ItemQuantity":{"description":"Describes the count or amount of an item","type":"object","additionalProperties":false,"properties":{"allocated":{"description":"This represents the exact quantity allocated for purchase of the item.","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"measure":{"$ref":"#/components/schemas/Scalar"}}},"available":{"description":"This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"measure":{"$ref":"#/components/schemas/Scalar"}}},"maximum":{"description":"This represents the maximum quantity allowed for purchase of the item","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":1},"measure":{"$ref":"#/components/schemas/Scalar"}}},"minimum":{"description":"This represents the minimum quantity allowed for purchase of the item","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"measure":{"$ref":"#/components/schemas/Scalar"}}},"selected":{"description":"This represents the quantity selected for purchase of the item","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"measure":{"$ref":"#/components/schemas/Scalar"}}},"unitized":{"description":"This represents the quantity available in a single unit of the item","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":1,"maximum":1},"measure":{"$ref":"#/components/schemas/Scalar"}}}}},"Item":{"description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.","type":"object","additionalProperties":false,"properties":{"id":{"description":"ID of the item.","type":"string"},"parent_item_id":{"description":"ID of the item, this item is a variant of","allOf":[{"$ref":"#/components/schemas/Item/properties/id"}]},"parent_item_quantity":{"description":"The number of units of the parent item this item is a multiple of","allOf":[{"$ref":"#/components/schemas/ItemQuantity"}]},"descriptor":{"description":"Physical description of the item","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"creator":{"description":"The creator of this item","allOf":[{"$ref":"#/components/schemas/Organization"}]},"price":{"description":"The price of this item, if it has intrinsic value","allOf":[{"$ref":"#/components/schemas/Price"}]},"quantity":{"description":"The selling quantity of the item","allOf":[{"$ref":"#/components/schemas/ItemQuantity"}]},"margin":{"description":"The selling margin of the item","allOf":[{"$ref":"#/components/schemas/ItemQuantity"}]},"category_ids":{"description":"Categories this item can be listed under","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Category/properties/id"}]}},"fulfillment_ids":{"description":"Modes through which this item can be fulfilled","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Fulfillment/properties/id"}]}},"location_ids":{"description":"Provider Locations this item is available in","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Location/properties/id"}]}},"payment_ids":{"description":"Payment modalities through which this item can be ordered","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Payment/properties/id"}]}},"add_ons":{"type":"array","items":{"$ref":"#/components/schemas/AddOn"}},"cancellation_terms":{"description":"Cancellation terms of this item","type":"array","items":{"$ref":"#/components/schemas/CancellationTerm"}},"refund_terms":{"description":"Refund terms of this item","type":"array","items":{"description":"Refund term of an item or an order","type":"object","additionalProperties":false,"properties":{"fulfillment_state":{"description":"The state of fulfillment during which this term is applicable.","allOf":[{"$ref":"#/components/schemas/State"}]},"refund_eligible":{"description":"Indicates if cancellation will result in a refund","type":"boolean"},"refund_within":{"description":"Time within which refund will be processed after successful cancellation.","allOf":[{"$ref":"#/components/schemas/Time"}]},"refund_amount":{"$ref":"#/components/schemas/Price"}}}},"replacement_terms":{"description":"Terms that are applicable be met when this item is replaced","type":"array","items":{"$ref":"#/components/schemas/ReplacementTerm"}},"return_terms":{"description":"Terms that are applicable when this item is returned","type":"array","items":{"$ref":"#/components/schemas/ReturnTerm"}},"xinput":{"description":"Additional input required from the customer to purchase / avail this item","allOf":[{"$ref":"#/components/schemas/XInput"}]},"time":{"description":"Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.","allOf":[{"$ref":"#/components/schemas/Time"}]},"rateable":{"description":"Whether this item can be rated","type":"boolean"},"rating":{"description":"The rating of the item","allOf":[{"$ref":"#/components/schemas/Rating/properties/value"}]},"matched":{"description":"Whether this item is an exact match of the request","type":"boolean"},"related":{"description":"Whether this item is a related item to the exactly matched item","type":"boolean"},"recommended":{"description":"Whether this item is a recommended item to a response","type":"boolean"},"ttl":{"description":"Time to live in seconds for an instance of this schema","type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}},"creds":{"type":"array","items":{"$ref":"#/components/schemas/Credential"}}}},"Location":{"description":"The physical location of something","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"map_url":{"description":"The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.","type":"string","format":"uri"},"gps":{"description":"The GPS co-ordinates of this location.","allOf":[{"$ref":"#/components/schemas/Gps"}]},"updated_at":{"type":"string","format":"date-time"},"address":{"description":"The address of this location.","allOf":[{"$ref":"#/components/schemas/Address"}]},"city":{"description":"The city this location is, or is located within","allOf":[{"$ref":"#/components/schemas/City"}]},"district":{"description":"The state this location is, or is located within","type":"string"},"state":{"description":"The state this location is, or is located within","allOf":[{"$ref":"#/components/schemas/State"}]},"country":{"description":"The country this location is, or is located within","allOf":[{"$ref":"#/components/schemas/Country"}]},"area_code":{"type":"string"},"circle":{"$ref":"#/components/schemas/Circle"},"polygon":{"description":"The boundary polygon of this location","type":"string"},"3dspace":{"description":"The three dimensional region describing this location","type":"string"},"rating":{"description":"The rating of this location","allOf":[{"$ref":"#/components/schemas/Rating/properties/value"}]},"time":{"description":"Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Time"}]}}}},"MediaFile":{"description":"This object contains a url to a media file.","type":"object","additionalProperties":false,"properties":{"mimetype":{"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":{"description":"The URL of the file","type":"string","format":"uri"},"signature":{"description":"The digital signature of the file signed by the sender","type":"string"},"dsa":{"description":"The signing algorithm used by the sender","type":"string"}}},"Offer":{"description":"An offer associated with a catalog. This is typically used to promote a particular product and enable more purchases.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"location_ids":{"type":"array","items":{"$ref":"#/components/schemas/Location/properties/id"}},"category_ids":{"type":"array","items":{"$ref":"#/components/schemas/Category/properties/id"}},"item_ids":{"type":"array","items":{"$ref":"#/components/schemas/Item/properties/id"}},"time":{"$ref":"#/components/schemas/Time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"Option":{"description":"Describes a selectable option","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"descriptor":{"$ref":"#/components/schemas/Descriptor"}}},"Order":{"description":"Describes a legal purchase order. It contains the complete details of the legal contract created between the buyer and the seller.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Human-readable ID of the order. This is generated at the BPP layer. The BPP can either generate order id within its system or forward the order ID created at the provider level."},"ref_order_ids":{"description":"A list of order IDs to link this order to previous orders.","type":"array","items":{"type":"string","description":"ID of a previous order"}},"status":{"description":"Status of the order. Allowed values can be defined by the network policy","type":"string","enum":["ACTIVE","COMPLETE","CANCELLED","COMPLETED","SOFT_CANCEL","CANCELLATION_INITIATED","CANCELLATION_REJECTED","SOFT_UPDATE","CONFIRM_UPDATE","UPDATED"]},"type":{"description":"This is used to indicate the type of order being created to BPPs. Sometimes orders can be linked to previous orders, like a replacement order in a retail domain. A follow-up consultation in healthcare domain. A single order part of a subscription order. The list of order types can be standardized at the network level.","type":"string","default":"DEFAULT","enum":["DRAFT","DEFAULT"]},"provider":{"description":"Details of the provider whose catalog items have been selected.","allOf":[{"$ref":"#/components/schemas/Provider"}]},"items":{"description":"The items purchased / availed in this order","type":"array","items":{"$ref":"#/components/schemas/Item"}},"add_ons":{"description":"The add-ons purchased / availed in this order","type":"array","items":{"$ref":"#/components/schemas/AddOn"}},"offers":{"description":"The offers applied in this order","type":"array","items":{"$ref":"#/components/schemas/Offer"}},"billing":{"description":"The billing details of this order","allOf":[{"$ref":"#/components/schemas/Billing"}]},"fulfillments":{"description":"The fulfillments involved in completing this order","type":"array","items":{"$ref":"#/components/schemas/Fulfillment"}},"cancellation":{"description":"The cancellation details of this order","allOf":[{"$ref":"#/components/schemas/Cancellation"}]},"cancellation_terms":{"description":"Cancellation terms of this item","type":"array","items":{"$ref":"#/components/schemas/CancellationTerm"}},"documents":{"type":"array","items":{"description":"Documnents associated to the order","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"mime_type":{"description":"This field indicates the nature and format of the form received by querying the url. MIME types are defined and standardized in IETF's RFC 6838.","type":"string","enum":["text/html","application/html","application/xml","application/pdf"]},"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.","type":"string","format":"uri"}}}},"refund_terms":{"description":"Refund terms of this item","type":"array","items":{"$ref":"#/components/schemas/Item/properties/refund_terms/items"}},"replacement_terms":{"description":"Replacement terms of this item","type":"array","items":{"$ref":"#/components/schemas/ReplacementTerm"}},"return_terms":{"description":"Return terms of this item","type":"array","items":{"$ref":"#/components/schemas/ReturnTerm"}},"quote":{"description":"The mutually agreed upon quotation for this order.","allOf":[{"$ref":"#/components/schemas/Quotation"}]},"payments":{"description":"The terms of settlement for this order","type":"array","items":{"$ref":"#/components/schemas/Payment"}},"created_at":{"description":"The date-time of creation of this order","type":"string","format":"date-time"},"updated_at":{"description":"The date-time of updated of this order","type":"string","format":"date-time"},"xinput":{"description":"Additional input required from the customer to confirm this order","allOf":[{"$ref":"#/components/schemas/XInput"}]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"Organization":{"description":"An organization. Usually a recognized business entity.","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"address":{"description":"The postal address of the organization","allOf":[{"$ref":"#/components/schemas/Address"}]},"state":{"description":"The state where the organization's address is registered","allOf":[{"$ref":"#/components/schemas/State"}]},"city":{"description":"The city where the the organization's address is registered","allOf":[{"$ref":"#/components/schemas/City"}]},"contact":{"$ref":"#/components/schemas/Contact"}}},"Payment":{"description":"Describes the terms of settlement between the BAP and the BPP for a single transaction. When instantiated, this object contains
  1. the amount that has to be settled,
  2. The payment destination destination details
  3. When the settlement should happen, and
  4. A transaction reference ID
. During a transaction, the BPP reserves the right to decide the terms of payment. However, the BAP can send its terms to the BPP first. If the BPP does not agree to those terms, it must overwrite the terms and return them to the BAP. If overridden, the BAP must either agree to the terms sent by the BPP in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the BAP and the BPP can perform offline negotiations on the payment terms. Once an agreement is reached, the BAP and BPP can resume transactions.","type":"object","additionalProperties":false,"properties":{"id":{"description":"ID of the payment term that can be referred at an item or an order level in a catalog","type":"string"},"collected_by":{"description":"This field indicates who is the collector of payment. The BAP can set this value to 'bap' if it wants to collect the payment first and settle it to the BPP. If the BPP agrees to those terms, the BPP should not send the payment url. Alternatively, the BPP can set this field with the value 'bpp' if it wants the payment to be made directly.","type":"string"},"url":{"type":"string","description":"A payment url to be called by the BAP. If empty, then the payment is to be done offline. The details of payment should be present in the params object. If tl_method = http/get, then the payment details will be sent as url params. Two url param values, ```$transaction_id``` and ```$amount``` are mandatory.","format":"uri"},"tl_method":{"type":"string"},"params":{"type":"object","additionalProperties":false,"properties":{"transaction_id":{"type":"string","description":"The reference transaction ID associated with a payment activity"},"amount":{"type":"string"},"currency":{"type":"string"},"bank_code":{"type":"string"},"bank_account_number":{"type":"string"},"virtual_payment_address":{"type":"string"},"source_bank_code":{"type":"string"},"source_bank_account_number":{"type":"string"},"source_virtual_payment_address":{"type":"string"}}},"type":{"type":"string","enum":["PRE_ORDER","PRE_FULFILLMENT","ON_FULFILLMENT","POST_FULFILLMENT","ON_ORDER","PART_PAYMENT","ON_CANCELLATION","POST_CANCELLATION"]},"status":{"type":"string","enum":["PAID","NOT_PAID"]},"time":{"$ref":"#/components/schemas/Time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"Person":{"description":"Describes a person as any individual","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Describes the identity of the person"},"url":{"description":"Profile url of the person","type":"string","format":"uri"},"name":{"description":"the name of the person","type":"string"},"image":{"$ref":"#/components/schemas/Image"},"age":{"description":"Age of the person","allOf":[{"$ref":"#/components/schemas/Duration"}]},"dob":{"description":"Date of birth of the person","type":"string","format":"date"},"gender":{"type":"string","description":"Gender of something, typically a Person, but possibly also fictional characters, animals, etc. While Male and Female may be used, text strings are also acceptable for people who do not identify as a binary gender.Allowed values for this field can be published in the network policy"},"creds":{"type":"array","items":{"$ref":"#/components/schemas/Credential"}},"languages":{"type":"array","items":{"description":"Describes a language known to the person.","type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"name":{"type":"string"}}}},"skills":{"type":"array","items":{"description":"Describes a skill of the person.","type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"name":{"type":"string"}}}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}},"descriptor":{"$ref":"#/components/schemas/Descriptor"}}},"Price":{"description":"Describes the price of a product or service","type":"object","additionalProperties":false,"properties":{"currency":{"type":"string"},"value":{"$ref":"#/components/schemas/DecimalValue"},"estimated_value":{"$ref":"#/components/schemas/DecimalValue"},"computed_value":{"$ref":"#/components/schemas/DecimalValue"},"listed_value":{"$ref":"#/components/schemas/DecimalValue"},"offered_value":{"$ref":"#/components/schemas/DecimalValue"},"minimum_value":{"$ref":"#/components/schemas/DecimalValue"},"maximum_value":{"$ref":"#/components/schemas/DecimalValue"}}},"Provider":{"description":"Describes the catalog of a business.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Id of the provider"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"category_id":{"type":"string","description":"Category Id of the provider at the BPP-level catalog"},"rating":{"$ref":"#/components/schemas/Rating/properties/value"},"time":{"$ref":"#/components/schemas/Time"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"fulfillments":{"type":"array","items":{"$ref":"#/components/schemas/Fulfillment"}},"payments":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"}},"offers":{"type":"array","items":{"$ref":"#/components/schemas/Offer"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"exp":{"type":"string","description":"Time after which catalog has to be refreshed","format":"date-time"},"rateable":{"description":"Whether this provider can be rated or not","type":"boolean"},"ttl":{"description":"The time-to-live in seconds, for this object. This can be overriden at deeper levels. A value of -1 indicates that this object is not cacheable.","type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}},"cancellation_terms":{"description":"Cancellation terms of this item","type":"array","items":{"$ref":"#/components/schemas/CancellationTerm"}}}},"Quotation":{"description":"Describes a quote. It is the estimated price of products or services from the BPP.
This has properties like price, breakup, ttl","type":"object","additionalProperties":false,"properties":{"id":{"description":"ID of the quote.","type":"string"},"price":{"description":"The total quoted price","allOf":[{"$ref":"#/components/schemas/Price"}]},"breakup":{"description":"the breakup of the total quoted price","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"item":{"$ref":"#/components/schemas/Item"},"title":{"type":"string"},"price":{"$ref":"#/components/schemas/Price"}}}},"ttl":{"$ref":"#/components/schemas/Duration"}}},"Rating":{"description":"Describes the rating of an entity","type":"object","additionalProperties":false,"properties":{"rating_category":{"description":"Category of the entity being rated","type":"string","enum":["ITEM","ORDER","FULFILLMENT","PROVIDER","AGENT","SUPPORT"]},"id":{"description":"Id of the object being rated","type":"string"},"value":{"description":"Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.","type":"string"}}},"Region":{"description":"Describes an arbitrary region of space. The network policy should contain a published list of supported regions by the network.","type":"object","additionalProperties":false,"properties":{"dimensions":{"description":"The number of dimensions that are used to describe any point inside that region. The most common dimensionality of a region is 2, that represents an area on a map. There are regions on the map that can be approximated to one-dimensional regions like roads, railway lines, or shipping lines. 3 dimensional regions are rarer, but are gaining popularity as flying drones are being adopted for various fulfillment services.","type":"string","enum":["1","2","3"]},"type":{"description":"The type of region. This is used to specify the granularity of the region represented by this object. Various examples of two-dimensional region types are city, country, state, district, and so on. The network policy should contain a list of all possible region types supported by the network.","type":"string"},"name":{"type":"string","description":"Name of the region as specified on the map where that region exists."},"code":{"type":"string","description":"A standard code representing the region. This should be interpreted in the same way by all network participants."},"boundary":{"type":"string","description":"A string representing the boundary of the region. One-dimensional regions are represented by polylines. Two-dimensional regions are represented by polygons, and three-dimensional regions can represented by polyhedra."},"map_url":{"type":"string","description":"The url to the map of the region. This can be a globally recognized map or the one specified by the network policy."}}},"ReplacementTerm":{"description":"The replacement policy of an item or an order","type":"object","additionalProperties":false,"properties":{"fulfillment_state":{"description":"The state of fulfillment during which this term is applicable.","allOf":[{"$ref":"#/components/schemas/State"}]},"replace_within":{"description":"Applicable only for buyer managed returns where the buyer has to replace the item before a certain date-time, failing which they will not be eligible for replacement","allOf":[{"$ref":"#/components/schemas/Time"}]},"external_ref":{"$ref":"#/components/schemas/MediaFile"}}},"ReturnTerm":{"description":"Describes the return policy of an item or an order","type":"object","additionalProperties":false,"properties":{"fulfillment_state":{"description":"The state of fulfillment during which this term IETF''s applicable.","allOf":[{"$ref":"#/components/schemas/State"}]},"return_eligible":{"description":"Indicates whether the item is eligible for return","type":"boolean"},"return_time":{"description":"Applicable only for buyer managed returns where the buyer has to return the item to the origin before a certain date-time, failing which they will not be eligible for refund.","allOf":[{"$ref":"#/components/schemas/Time"}]},"return_location":{"description":"The location where the item or order must / will be returned to","allOf":[{"$ref":"#/components/schemas/Location"}]},"fulfillment_managed_by":{"description":"The entity that will perform the return","type":"string","enum":["CONSUMER","PROVIDER"]}}},"Scalar":{"description":"Describes a scalar","type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["CONSTANT","VARIABLE"]},"value":{"$ref":"#/components/schemas/DecimalValue"},"estimated_value":{"$ref":"#/components/schemas/DecimalValue"},"computed_value":{"$ref":"#/components/schemas/DecimalValue"},"range":{"type":"object","additionalProperties":false,"properties":{"min":{"$ref":"#/components/schemas/DecimalValue"},"max":{"$ref":"#/components/schemas/DecimalValue"}}},"unit":{"type":"string"}}},"Schedule":{"description":"Describes schedule as a repeating time period used to describe a regularly recurring event. At a minimum a schedule will specify frequency which describes the interval between occurrences of the event. Additional information can be provided to specify the schedule more precisely. This includes identifying the timestamps(s) of when the event will take place. Schedules may also have holidays to exclude a specific day from the schedule.
This has properties like frequency, holidays, times","type":"object","additionalProperties":false,"properties":{"frequency":{"$ref":"#/components/schemas/Duration"},"holidays":{"type":"array","items":{"type":"string","format":"date-time"}},"times":{"type":"array","items":{"type":"string","format":"date-time"}}}},"State":{"description":"A bounded geopolitical region of governance inside a country.","type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the state"},"code":{"type":"string","description":"State code as per country or international standards"}}},"Stop":{"description":"A logical point in space and time during the fulfillment of an order.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"parent_stop_id":{"type":"string"},"location":{"description":"Location of the stop","allOf":[{"$ref":"#/components/schemas/Location"}]},"type":{"description":"The type of stop. Allowed values of this property can be defined by the network policy.","type":"string"},"time":{"description":"Timings applicable at the stop.","allOf":[{"$ref":"#/components/schemas/Time"}]},"instructions":{"description":"Instructions that need to be followed at the stop","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"contact":{"description":"Contact details of the stop","allOf":[{"$ref":"#/components/schemas/Contact"}]},"person":{"description":"The details of the person present at the stop","allOf":[{"$ref":"#/components/schemas/Person"}]},"authorization":{"$ref":"#/components/schemas/Authorization"}}},"Support":{"description":"Details of customer support","type":"object","additionalProperties":false,"properties":{"ref_id":{"type":"string"},"callback_phone":{"type":"string","format":"phone"},"phone":{"type":"string","format":"phone"},"email":{"type":"string","format":"email"},"url":{"type":"string","format":"uri"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"ref_type":{"type":"string"}}},"Tag":{"description":"Describes a tag. This is used to contain extended metadata. This object can be added as a property to any schema to describe extended attributes. For BAPs, tags can be sent during search to optimize and filter search results. BPPs can use tags to index their catalog to allow better search functionality. Tags are sent by the BPP as part of the catalog response in the `on_search` callback. Tags are also meant for display purposes. Upon receiving a tag, BAPs are meant to render them as name-value pairs. This is particularly useful when rendering tabular information about a product or service.","type":"object","additionalProperties":false,"properties":{"descriptor":{"description":"Description of the Tag, can be used to store detailed information.","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"value":{"description":"The value of the tag. This set by the BPP and rendered as-is by the BAP.","type":"string"},"display":{"description":"This value indicates if the tag is intended for display purposes. If set to `true`, then this tag must be displayed. If it is set to `false`, it should not be displayed. This value can override the group display value.","type":"boolean"}}},"TagGroup":{"description":"A collection of tag objects with group level attributes. For detailed documentation on the Tags and Tag Groups schema go to https://github.com/beckn/protocol-specifications/discussions/316","type":"object","additionalProperties":false,"properties":{"display":{"description":"Indicates the display properties of the tag group. If display is set to false, then the group will not be displayed. If it is set to true, it should be displayed. However, group-level display properties can be overriden by individual tag-level display property. As this schema is purely for catalog display purposes, it is not recommended to send this value during search.","type":"boolean","default":true},"descriptor":{"description":"Description of the TagGroup, can be used to store detailed information.","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"list":{"description":"An array of Tag objects listed under this group. This property can be set by BAPs during search to narrow the `search` and achieve more relevant results. When received during `on_search`, BAPs must render this list under the heading described by the `name` property of this schema.","type":"array","items":{"$ref":"#/components/schemas/Tag"}}}},"Time":{"description":"Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operations
This has properties like label, time stamp,duration,range, days, schedule","type":"object","additionalProperties":false,"properties":{"label":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"duration":{"$ref":"#/components/schemas/Duration"},"range":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"days":{"type":"string","description":"comma separated values representing days of the week"},"schedule":{"$ref":"#/components/schemas/Schedule"}}},"Tracking":{"description":"Contains tracking information that can be used by the BAP to track the fulfillment of an order in real-time. which is useful for knowing the location of time sensitive deliveries.","type":"object","additionalProperties":false,"properties":{"id":{"description":"A unique tracking reference number","type":"string"},"url":{"description":"A URL to the tracking endpoint. This can be a link to a tracking webpage, a webhook URL created by the BAP where BPP can push the tracking data, or a GET url creaed by the BPP which the BAP can poll to get the tracking data. It can also be a websocket URL where the BPP can push real-time tracking data.","type":"string","format":"uri"},"location":{"description":"In case there is no real-time tracking endpoint available, this field will contain the latest location of the entity being tracked. The BPP will update this value everytime the BAP calls the track API.","allOf":[{"$ref":"#/components/schemas/Location"}]},"status":{"description":"This value indicates if the tracking is currently active or not. If this value is `active`, then the BAP can begin tracking the order. If this value is `inactive`, the tracking URL is considered to be expired and the BAP should stop tracking the order.","type":"string","enum":["active","inactive"]}}},"Vehicle":{"description":"Describes a vehicle is a device that is designed or used to transport people or cargo over land, water, air, or through space.
This has properties like category, capacity, make, model, size,variant,color,energy_type,registration","type":"object","additionalProperties":false,"properties":{"category":{"type":"string"},"capacity":{"type":"integer"},"make":{"type":"string"},"model":{"type":"string"},"size":{"type":"string"},"variant":{"type":"string"},"color":{"type":"string"},"energy_type":{"type":"string"},"registration":{"type":"string"},"wheels_count":{"type":"string"},"cargo_volumne":{"type":"string"},"wheelchair_access":{"type":"string"},"code":{"type":"string"},"emission_standard":{"type":"string"}}},"XInput":{"description":"Contains any additional or extended inputs required to confirm an order. This is typically a Form Input. Sometimes, selection of catalog elements is not enough for the BPP to confirm an order. For example, to confirm a flight ticket, the airline requires details of the passengers along with information on baggage, identity, in addition to the class of ticket. Similarly, a logistics company may require details on the nature of shipment in order to confirm the shipping. A recruiting firm may require additional details on the applicant in order to confirm a job application. For all such purposes, the BPP can choose to send this object attached to any object in the catalog that is required to be sent while placing the order. This object can typically be sent at an item level or at the order level. The item level XInput will override the Order level XInput as it indicates a special requirement of information for that particular item. Hence the BAP must render a separate form for the Item and another form at the Order level before confirmation.","type":"object","additionalProperties":false,"properties":{"head":{"description":"Provides the header information for the xinput.","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"index":{"type":"object","additionalProperties":false,"properties":{"min":{"type":"integer"},"cur":{"type":"integer"},"max":{"type":"integer"}}},"headings":{"type":"array","items":{"type":"string","description":"The heading names of the forms"}}}},"form":{"$ref":"#/components/schemas/Form"},"form_response":{"description":"Describes the response to a form submission","type":"object","additionalProperties":false,"properties":{"status":{"description":"Contains the status of form submission.","type":"string"},"signature":{"type":"string"},"submission_id":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}},"required":{"description":"Indicates whether the form data is mandatorily required by the BPP to confirm the order.","type":"boolean"}}}}},"x-enum":{"search":{"context":{"action":[{"code":"search","description":"Buyer app indicates the search intent","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"intent":{"category":{"descriptor":{"code":[{"code":"ON_DEMAND_TRIP","description":"Describes the category of the on_demand offer","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"catalog":{"providers":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]}},"on_status":{"context":{"action":[{"code":"on_status","description":"Seller app return order with status , Driver pickup - driver drop","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}]}}}}},"cancel":{"context":{"action":[{"code":"cancel","description":"Buyer app requests order cancellation.\"","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"cancellation":{"reason":{"descriptor":{"code":[{"code":"000","description":"Technical cancellation of orders in case protocol technical failures(BAP/BPP)","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""},{"code":"PROVIDER","description":"Describes, when the ride is cancelled by the provider.","reference":""}],"reason":{"descriptor":{"code":[{"code":"000","description":"Technical cancellation of orders in case protocol technical failures(BAP/BPP)","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]}},"on_track":{"context":{"action":[{"code":"on_track","description":"Seller app specifies the on_track.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]}}},"x-tags":{"search":{"message":{"intent":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"item":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]}]}}}},"on_search":{"message":{"catalog":{"tags":[{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"providers":{"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]}}}}},"on_select":{"message":{"order":{"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"init":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}]}}},"on_init":{"message":{"order":{"tags":[{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"confirm":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"on_confirm":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"on_status":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"on_cancel":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"on_update":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}}},"x-flows":[{"summary":"On-Demand - Assign driver on on-confirm","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"payment_ids":["PA1","PA2"],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"id":"PA1","type":"ON_FULFILLMENT","collected_by":"BPP","status":"NOT_PAID"},{"id":"PA2","type":"POST_CANCELLATION","status":"NOT_PAID","collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver on on-confirm (Add Ons)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"available":{"count":1},"maximum":{"count":1}}}],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"available":{"count":1},"maximum":{"count":1}}}],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"he Buyer App selects a specific service and may optionally choose add-ons","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":1}}}]}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":1}}}]}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":1}}}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver on on-confirm(BAP Collecting)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[BAP Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BAP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[BAP Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[BAP Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BAP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[BAP Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app provides the payment update to Seller app","api":"update","details":[{"description":"Buyer app provides the payment update to Seller app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Buyer app provides the payment update to Seller app","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"47e05cc2-2bc4-41c9-81fb-26be6ae74403","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.payments","order":{"id":"01","payments":[{"collected_by":"BAP","id":"PA1","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"},"status":"PAID","type":"ON_FULFILLMENT"}]}}}}},{"summary":"Seller app provides the latest order status with updated payment details","api":"on_update","details":[{"description":"Seller app provides the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n \n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Seller app provides the latest order status","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver on on-confirm(BAP Collecting, On-Order)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[BAP Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BAP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[BAP Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[BAP Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BAP","status":"NOT_PAID","type":"PRE_ORDER"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[BAP Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"PRE_ORDER"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver on on-confirm(BAP Collecting, Quote-Update)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[BAP Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BAP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[BAP Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[BAP Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BAP","status":"NOT_PAID","type":"PRE_ORDER"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[BAP Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"PRE_ORDER"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride with updated fare details (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}},{"collected_by":"BAP","id":"PA2","status":"NOT_PAID","type":"POST_FULFILLMENT","params":{"amount":"10","currency":"INR"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app provides the payment update to Seller app","api":"update","details":[{"description":"Buyer app provides the payment update to Seller app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Buyer app provides the payment update to Seller app","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"47e05cc2-2bc4-41c9-81fb-26be6ae74403","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.payments","order":{"id":"01","payments":[{"collected_by":"BAP","id":"PA2","params":{"amount":"10","currency":"INR","transaction_id":"3cb81b36-5997-4fa9-9b5f-5b0b1ae25001"},"status":"PAID","type":"POST_FULFILLMENT"}]}}}}},{"summary":"Seller app provides the latest order status with updated payment details","api":"on_update","details":[{"description":"Seller app provides the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n \n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Seller app provides the latest order status","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}},{"collected_by":"BAP","id":"PA2","params":{"amount":"10","currency":"INR","transaction_id":"3cb81b36-5997-4fa9-9b5f-5b0b1ae25001"},"status":"PAID","type":"POST_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver post on-confirm","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"payment_ids":["PA1","PA2"],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"id":"PA1","type":"ON_FULFILLMENT","collected_by":"BPP","status":"NOT_PAID"},{"id":"PA2","type":"POST_CANCELLATION","status":"NOT_PAID","collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:48:34.53Z","tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the latest update on ride details to the buyer app.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy"}},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Assign driver post on-confirm(Self-Pickup)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"On Demand"}}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"payments":[{"collected_by":"BPP"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}]}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}]}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the latest update on ride details to the buyer app.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_status","details":[{"description":"Ride provider provides the latest update on ride details to the buyer app with fulfillment state - RIDE_STARTED","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"PAID","type":"ON_FULFILLMENT","params":{"amount":"146"}}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Female Driver Flow","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"customer":{"person":{"gender":"FEMALE"}},"agent":{"person":{"gender":"FEMALE"}},"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}},{"id":"F3","customer":{"person":{"gender":"FEMALE"}},"agent":{"person":{"gender":"FEMALE"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"CAB Economy Ride – Female Driver"},"category_ids":["C1"],"fulfillment_ids":["F3"],"id":"I3","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"matched":true,"recommended":false},{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"matched":false,"recommended":true},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"matched":false,"recommended":true}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Ride cancellation by driver","details":[{"description":"Detailed process of cancelling a ride with soft & confirm status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel (unsolicited)\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK "}],"steps":[{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel (unsolicited)\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider accepts the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel (unsolicited)\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end "}],"reference":"if any","example":{"summary":"Return current order status after confirm-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"0"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"0"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"PROVIDER","reason":{"descriptor":{"code":"013"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Ride cancellation by rider","details":[{"description":"Detailed process of cancelling a ride with soft & confirm status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app cancels the request for ride","api":"cancel","details":[{"description":"Buyer app requests for cancellation of ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with soft cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts/appends the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after soft-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the cancel request for ride","api":"cancel","details":[{"description":"Buyer app give the confirmation to cancel the ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with confirm cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"CONFIRM_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after confirm-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"ACTIVE","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Technical Cancellation Flow","details":[{"description":"Detailed process of cancelling a ride with soft & confirm status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): NACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK \n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK "}],"reference":"if any","steps":[{"summary":"Provider confirms the request","api":"on_confirm","details":[{"description":"The provider has confirmed the request, but the buyer app received the request after the TTL had expired.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): NACK \n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK "}],"reference":"if any","example":{"value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app request for latest order status","api":"status","details":[{"description":"Buyer app request for latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): NACK \n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK "}],"reference":"if any","example":{"value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"ref_id":"870782be-6757-43f1-945c-8eeaf9536259"}}}},{"summary":"Provider sends the latest order status","api":"on_status","details":[{"description":"Provider sends the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): NACK \n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app cancels the request for ride(Optional)","api":"cancel","details":[{"description":"Buyer app requests for cancellation of ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8bbe4998-6243-4ce6-9859-c0f21c06d3db","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"000"}}},"descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Provider accepts/appends the terms of cancellation(Optional)","api":"on_cancel","details":[{"description":"Provider accepts the terms of order and appends its own terms and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"000"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the cancel request for ride","api":"cancel","details":[{"description":"Buyer app give the confirmation to cancel the ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8bbe4998-6243-4ce6-9859-c0f21c06d3db","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"000"}}},"descriptor":{"code":"CONFIRM_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Provider accepts the terms of cancellation","api":"on_cancel","details":[{"description":"Provider accepts the terms of order and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end "}],"reference":"if any","example":{"value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"000"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"Driver not found on on_confirm","references":"if any","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","reference":"if any","api":"on_confirm","example":{"value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"error":{"code":"90203","message":"Driver not assigned to the order"}}},"details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}]}]},{"summary":"Driver not found post on_confirm","references":"if any","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","reference":"if any","api":"on_confirm","example":{"value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:48:34.53Z","tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},"details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}]},{"summary":"Ride not found after on_confirm","reference":"if any","api":"on_cancel","example":{"value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"PROVIDER","reason":{"descriptor":{"code":"011"}}},"created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},"details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}]}]},{"summary":"On-Demand - Ride with multiple stops","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816","address":"XYZ, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END","id":"3","parent_stop_id":"2"}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","category_ids":["C1"],"location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","category_ids":["C1"],"location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","category_ids":["C1"],"location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Update Stop","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app requests for update of stop","api":"update","details":[{"description":"Buyer app request the provider platform to update the stop","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With fulfillment id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Update an active ride","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.fulfillments","order":{"id":"01","status":"SOFT_UPDATE","fulfillments":[{"id":"F1","stops":[{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}]}]}}}}},{"summary":"Provider platform confirms with on_update request","api":"on_update","details":[{"description":"Provider platform provides the updated order details","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"SOFT_UPDATE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for update of stop","api":"update","details":[{"description":"Buyer app request the provider platform to update the stop","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With fulfillment id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Update an active ride","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"47e05cc2-2bc4-41c9-81fb-26be6ae74403","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.fulfillments","order":{"id":"01","status":"CONFIRM_UPDATE","fulfillments":[{"id":"F1","stops":[{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}]}]}}}}},{"summary":"Provider platform confirms with on_update request","api":"on_update","details":[{"description":"Provider platform provides the updated order details","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"UPDATED","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Provider platform provide the latest order status","api":"on_status","details":[{"description":"Provider platform provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Pre Order Bid","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"payment_ids":["PA1","PA2"],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"id":"PA1","type":"ON_FULFILLMENT","collected_by":"BPP","status":"NOT_PAID"},{"id":"PA2","type":"POST_CANCELLATION","status":"NOT_PAID","collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","price":{"currency":"INR","value":"166"}}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"166"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"20"},"title":"BUYER_ADDITIONAL_AMOUNT"}],"price":{"currency":"INR","value":"166"},"ttl":"PT30S"}}}}}}]},{"summary":"On-Demand - Post Order Tip","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for update of quote (tipping)","api":"update","details":[{"description":"Buyer app requests for update of quote (tipping)","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With order id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated quote\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Update an active ride","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.quote.breakup","order":{"id":"O1","quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"20"},"title":"BUYER_ADDITIONAL_AMOUNT"}],"price":{"currency":"INR","value":"166"}}}}}}},{"summary":"Provider platform confirms with on_update request","api":"on_update","details":[{"description":"Provider platform provides the updated order details","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update quote\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated quote\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"PT60M"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"Delivery"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"DELAY_INTEREST"},"value":"2.5"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"1.46"},{"descriptor":{"code":"SETTLEMENT_BANK_CODE"},"value":"XXXXXXXX"},{"descriptor":{"code":"SETTLEMENT_BANK_ACCOUNT_NUMBER"},"value":"xxxxxxxxxxxxxx"},{"descriptor":{"code":"SETTLEMENT_VIRTUAL_PAYMENT_ADDRESS"},"value":"9988199772@okicic"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"20"},"title":"BUYER_ADDITIONAL_AMOUNT"}],"price":{"currency":"INR","value":"166"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Rental","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_RENTAL"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"circle":{"gps":"13.008935, 77.644408","radius":{"type":"CONSTANT","value":"100","unit":"KILOMETER"}}},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"category_ids":["C3"],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C3"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"add_ons":[{"id":"A2","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"1","unit":"HOURS"}}},"descriptor":{"name":"time","code":"TIME"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C3","descriptor":{"code":"ON_DEMAND_RENTAL","name":"Rental"}}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","category_ids":["C3"],"location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"Schedule - Rental","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"SCHEDULED_RENTAL"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C4"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"add_ons":[{"id":"A2","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"1","unit":"HOURS"}}},"descriptor":{"name":"time","code":"TIME"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C4","descriptor":{"code":"SCHEDULED_RENTAL","name":"Rental"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides the agent details","api":"on_update","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"4ce7055d-2511-4586-b18f-b50822048447","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACKs\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"Schedule - Trip","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title schedule Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"SCHEDULED_TRIP"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"}},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C2"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C2","descriptor":{"code":"SCHEDULED_TRIP","name":"scheduled"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides the agent details","api":"on_update","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n \n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Rental(when end stop gps coordinate is present)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_RENTAL"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"category_ids":["C3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C3"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"add_ons":[{"id":"A2","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"1","unit":"HOURS"}}},"descriptor":{"name":"time","code":"TIME"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C3","descriptor":{"code":"ON_DEMAND_RENTAL","name":"Rental"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"No Acceptance - Soft_Cancel","details":[{"description":"Detailed process of No Acceptance flow atter soft_cancel.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app cancels the request for ride","api":"cancel","details":[{"description":"Buyer app requests for cancellation of ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with soft cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts/appends the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return current order status after soft-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"time":{"duration":"PT2H"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"CAB Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider sends unsolicited on_status call","api":"on_status","details":[{"description":"The ride provider sends an unsolicited on_status call and reverted to the original order state as no response was received from the buyer app within the defined TTL.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after soft-cancel","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"975ff507-439e-4933-acf4-4aaed4af0d51","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"time":{"duration":"PT2H"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"CAB Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"No Acceptance - Soft_Update","details":[{"description":"Detailed process of No Acceptance flow atter soft_update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With fulfillment id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app requests for update of stop","api":"update","details":[{"description":"Buyer app request the provider platform to update the stop","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With fulfillment id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Update an active ride","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.fulfillments","order":{"id":"01","status":"SOFT_UPDATE","fulfillments":[{"id":"F1","stops":[{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}]}]}}}}},{"summary":"Provider platform confirms with on_update request","api":"on_update","details":[{"description":"Provider platform provides the updated order details","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"SOFT_UPDATE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider sends unsolicited on_status call","api":"on_status","details":[{"description":"The ride provider sends an unsolicited on_status call and reverted to the original order state as no response was received from the buyer app within the defined TTL.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"a6ef2152-7cec-4560-b0ec-04fb13691813","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"BPP Collecting - Payment Confirmation","details":[{"description":"The illustrative flow depicts the comprehensive process of payment confirmation, showcasing the sequential steps and interactions involved in a payment transaction.","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP) ->> Buyer Platform (BAP) : form"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Buyer Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP) ->> Buyer Platform (BAP) : form"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Buyer Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app redirects to payment gateway page.","api":"form","details":[{"description":"Buyer app redirects to payment gateway page using the link provided in the previous step.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP) ->> Buyer Platform (BAP) : form\n end"}],"reference":"if any","example":{"value":"This will redirected to different html page"}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"ref_id":"870782be-6757-43f1-945c-8eeaf9536259"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Buyer Collecting]","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c","amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"}}}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"9a7be37d-f228-432b-9aa9-65144d48da38","timestamp":"2023-12-10T04:34:49.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"9a7be37d-f228-432b-9aa9-65144d48da38","timestamp":"2023-12-10T04:34:52.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c","amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T04:34:52.031Z","updated_at":"2023-12-10T04:34:52.031Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Purple Tags (Assign driver on on-confirm)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"eb60e750-2b11-4170-8bd3-b4c6370835d9","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare & list of supported purple tags.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"eb60e750-2b11-4170-8bd3-b4c6370835d9","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"category_ids":["C5"],"tags":[{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"}},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"}},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"}},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"}}]},{"descriptor":{"name":"Dwarfism","code":"DISABILITY_DWARFISM"},"display":false,"list":[{"descriptor":{"code":"DWARFISM_SPECIAL_REQUIREMENT","name":"Dwarfism","short_desc":"Custom description"}}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C5"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C5","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service & select specific purple tags.","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"01c1903c-f943-4c11-8e93-dff5ce3c30bd","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","tags":[{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"01c1903c-f943-4c11-8e93-dff5ce3c30bd","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"category_ids":["C5"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"category_ids":["C5"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}] "}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"category_ids":["C5"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Ride cancellation by rider(BAP Collecting)","details":[{"description":"Detailed process of cancelling a ride with soft & confirm status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app cancels the request for ride","api":"cancel","details":[{"description":"Buyer app requests for cancellation of ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with soft cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts/appends the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after soft-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"},{"collected_by":"BAP","id":"PA2","status":"NOT_PAID","type":"POST_CANCELLATION"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the cancel request for ride","api":"cancel","details":[{"description":"Buyer app give the confirmation to cancel the ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with confirm cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"CONFIRM_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after confirm-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"},{"collected_by":"BAP","id":"PA2","status":"NOT_PAID","type":"POST_CANCELLATION"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"ACTIVE","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app shares the updated payment status with Seller app.","api":"update","details":[{"description":"Buyer app shares the updated payment status with Seller app.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Buyer app shares the updated payment status with Seller app.","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"396a3c9a-838d-46cd-8fd9-311b93cdb2d0","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.payments","order":{"id":"01","payments":[{"collected_by":"BAP","id":"PA2","params":{"amount":"10","currency":"INR","transaction_id":"ed8bebf6-1ed8-48d0-8506-e0bc35d93d60"},"status":"PAID","type":"POST_CANCELLATION"}]}}}}},{"summary":"Seller app shares the updated order status.","api":"on_update","details":[{"description":"Seller app shares the updated order status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Seller app shares the updated order status.","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"396a3c9a-838d-46cd-8fd9-311b93cdb2d0","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"},{"collected_by":"BAP","id":"PA2","params":{"amount":"10","currency":"INR","transaction_id":"ed8bebf6-1ed8-48d0-8506-e0bc35d93d60"},"status":"PAID","type":"POST_CANCELLATION"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Support","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"The Buyer App initiates the support request","api":"support","details":[{"description":"The Buyer App initiates the support request","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): support\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_support\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"support","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"396a3c9a-838d-46cd-8fd9-311b93cdb2d0","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"support":{"descriptor":{"code":"SOS","name":"sos emergency","short_desc":"Driver has deviated from the planned route."},"ref_type":"ORDER","ref_id":"O1"}}}}},{"summary":"The Seller App returns the on_support response to the Buyer App.","api":"on_support","details":[{"description":"The Seller App returns the on_support response to the Buyer App.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): support\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_support\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_support","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"396a3c9a-838d-46cd-8fd9-311b93cdb2d0","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"support":{"descriptor":{"code":"SOS","name":"sos emergency","short_desc":"Driver has deviated from the planned route."},"ref_type":"ORDER","ref_id":"O1","email":"support@example-bpp.com","phone":"+918068870525","url":"https://example-bpp.com/prod/seller/gethelp"}}}}}]}],"x-examples":{"on-demand":{"summary":"On Demand Use Case Specification","description":"The On-demand use case on the network would enable NPs to perform on-demand ride hailing related transactions on the network. These APIs are utilized by consumer and provider platforms enabling every consumer/ end-user on all consumer platforms to consume the services/ inventory provided by all provider platforms on the network seamlessly. Consumer platforms shall use these specifications to perform transaction operations like discovery, selection, booking, status check and others so as to purchase services/ inventory on the network eg: autos, cabs etc. Provider Platform shall use these specifications to expose their services/ inventory in form of autos or cabs rides. Gateway specifications are used to broadcast demands originating from a consumer platform to all applicable provider platforms in a transparent and unbiased manner.","example_set":{"cancel":{"examples":[{"summary":"Initiates_cancelling_a_ride_with_confirm_cancel_status___X5","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"CONFIRM_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}},{"summary":"Initiates_cancelling_a_ride_with_soft_cancel_status___X4","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}]},"confirm":{"examples":[{"summary":"Confirm_ride_booking___X6","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"confirm_buyer_app_confirms_the_booking_and_provides_all_the_required_information_for_confirmation_as_per_the_terms_of_the_order__5","description":"TBD","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"confirm_buyer_app_confirms_the_booking_and_provides_all_the_required_information_for_confirmation_as_per_the_terms_of_the_order__6","description":"TBD","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"9a7be37d-f228-432b-9aa9-65144d48da38","timestamp":"2023-12-10T04:34:49.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"init":{"examples":[{"summary":"Initialize_draft_order_and_request_for_terms_of_service[Seller_Collecting]___X7","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}},{"summary":"init_buyer_app_platform_shares_the_terms_of_order_and_initializes_the_request__1","description":"TBD","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"init_buyer_app_platform_shares_the_terms_of_order_and_initializes_the_request__3","description":"TBD","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"on_cancel":{"examples":[{"summary":"Return_current_order_status_after_confirm-cancel___X9","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"0"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"0"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"PROVIDER","reason":{"descriptor":{"code":"013"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"Return_current_order_status_after_soft-cancel___X8","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"time":{"duration":"PT2H"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"CAB Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"cancel_after_confirm","description":"TBD","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"PROVIDER","reason":{"descriptor":{"code":"011"}}},"created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"on_confirm":{"examples":[{"summary":"Return_confirmed_order_with_latest_fulfillment_details___X10","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"Return_confirmed_order_with_latest_fulfillment_details___X11","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:48:34.53Z","tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"Return_confirmed_order_with_latest_fulfillment_details___X12","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","params":{"amount":"146","currency":"INR","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259"},"status":"PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"DELAY_INTEREST"},"value":"5"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"P2D"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"DELIVERY"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"144.54"},{"descriptor":{"code":"SETTLEMENT_BANK_CODE"},"value":"XXXXXXXX"},{"descriptor":{"code":"SETTLEMENT_BANK_ACCOUNT_NUMBER"},"value":"xxxxxxxxxxxxxx"},{"descriptor":{"code":"SETTLEMENT_VIRTUAL_PAYMENT_ADDRESS"},"value":"9988199772@okicic"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}},{"summary":"on_confirm_ride_provider_confirms_the_ride_request_and_provides_the_ride_details_on_confirmation__6","description":"TBD","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_confirm_ride_provider_confirms_the_ride_request_and_provides_the_ride_details_on_confirmation__7","description":"TBD","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"9a7be37d-f228-432b-9aa9-65144d48da38","timestamp":"2023-12-10T04:34:52.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c","amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T04:34:52.031Z","updated_at":"2023-12-10T04:34:52.031Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"ride_cancelled","description":"TBD","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"error":{"code":"90203","message":"Driver not assigned to the order"}}}]},"on_init":{"examples":[{"summary":"Return_draft_order_with_payment_terms[Seller_Collecting]___X13","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_init_ride_provider_accepts_the_terms_of_order_and_appends_its_own_terms_and_responds_with_the_final_draft__2","description":"TBD","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_init_ride_provider_accepts_the_terms_of_order_and_appends_its_own_terms_and_responds_with_the_final_draft__4","description":"TBD","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}]}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"on_rating":{"examples":[{"summary":"Return_acknowledgement_of_rating_and_feedback___X14","value":{"context":{"action":"on_rating","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"2a17e268-1dc4-4d1a-98a2-17554a50c7d2","timestamp":"2023-03-23T05:41:15Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"feedback_ack":true,"rating_ack":true}}}]},"on_search":{"examples":[{"summary":"Return_a_mobility_catalog[Buyer_Collecting]___X16","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BAP"}]}],"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"DELAY_INTEREST"},"value":"5"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"}]}]}}}},{"summary":"Return_a_mobility_catalog[Seller_Collecting]___X15","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"payment_ids":["PA1","PA2"],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"id":"PA1","type":"ON_FULFILLMENT","collected_by":"BPP","status":"NOT_PAID"},{"id":"PA2","type":"POST_CANCELLATION","status":"NOT_PAID","collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_search_ride_providers_which_is_a_mobility_provider_platform_sends_the_catalog_of_all_services_that_can_be_used_for_transit_from_a_to_b_along_with_estimated_fare__1","description":"TBD","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"On Demand"}}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"payments":[{"collected_by":"BPP"}]}]}}}}]},"on_select":{"examples":[{"summary":"Return_a_quote_offered_by_a_provider___X17","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}},{"summary":"on_select_ride_provider_responds_with_detailed_information_and_quote_for_the_specific_service_that_the_buyer_app_would_like_to_avail__2","description":"TBD","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}]}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}]},"on_status":{"examples":[{"summary":"Return_order_with_latest_fulfillment_status_-_Driver_en-route_to_pickup___X19","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP","name":"Driver is en-route to your location"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"PT60M"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"Delivery"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"DELAY_INTEREST"},"value":"2.5"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"174"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}},{"summary":"Return_order_with_latest_status_-_Ride_Ended___X21","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"AUTO_RICKSHAW","make":"Mahindra","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"PT60M"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"Delivery"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"DELAY_INTEREST"},"value":"2.5"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"174"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}},{"summary":"Return_order_with_latest_status_-_Ride_started___X20","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED","name":"Your ride has started"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","params":{"bank_account_number":"xxxxxxxxxxxxxx","bank_code":"XXXXXXXX","virtual_payment_address":"9988199772@okicic"},"status":"NOT_PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"PT60M"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"Delivery"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"DELAY_INTEREST"},"value":"2.5"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"174"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}},{"summary":"Return_order_with_status_-_Driver_at_pickup___X18","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_status_ride_provider_provides_the_latest_update_on_ride_details_to_the_buyer_app_with_fulfillment_state___ride_started_8","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_1","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_10","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"PAID","type":"ON_FULFILLMENT","params":{"amount":"146"}}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_2","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_3","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_4","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"156","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_5","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c","amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"}}}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_12","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"on_support":{"examples":[{"summary":"Return_support_information_related_to_an_order___X22","value":{"context":{"action":"on_support","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"support":{"email":"support@nammayatri.in","phone":"+918068870525","url":"https://support.nammayatri.com/gethelp"}}}}]},"on_track":{"examples":[{"summary":"Return_tracking_information_for_an_order___X23","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}]},"on_update":{"examples":[{"summary":"Return_updated_order_with_recomputed_charges___X24","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}},{"summary":"Return_updated_order_with_updated_agent_details___X26","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}},{"summary":"Return_updated_order_with_updated_billing_details___X25","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"email":"jane.doe@example.com","name":"Jane Doe","phone":"+91-9897867564"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"DELAY_INTEREST"},"value":"5"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"P2D"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"DELIVERY"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"1.46"},{"descriptor":{"code":"SETTLEMENT_BANK_CODE"},"value":"XXXXXXXX"},{"descriptor":{"code":"SETTLEMENT_BANK_ACCOUNT_NUMBER"},"value":"xxxxxxxxxxxxxx"},{"descriptor":{"code":"SETTLEMENT_VIRTUAL_PAYMENT_ADDRESS"},"value":"9988199772@okicic"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:53Z","updated_at":"2023-03-23T04:48:53Z"}}}},{"summary":"on_update_ride_provider_provides_the_latest_update_on_ride_details_to_the_buyer_app__7","description":"TBD","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_update_ride_provider_provides_the_updated_order_updates_to_the_buyer_app___can_update_the_quote_in_case_of_fare_update_9","description":"TBD","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"rating":{"examples":[{"summary":"Provide_a_rating___X27","value":{"context":{"action":"rating","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"b462a835-97d6-4479-bec8-9660a0f8513e","timestamp":"2023-03-23T04:46:45Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"id":"b0462745-f6c9-4100-bbe7-4fa3648b6b40","rating_category":"DRIVER","value":4}}},{"summary":"Provide_a_rating_with_feedback_form_data___X28","value":{"context":{"action":"rating","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"849db48a-34c0-454b-86cb-60864482941b","timestamp":"2023-03-23T04:46:45Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"feedback_form":[{"answer":"Driver took me on a route not shown by Google Maps and we reached 10 minutes before time","id":"1"}],"id":"b0462745-f6c9-4100-bbe7-4fa3648b6b40","rating_category":"DRIVER","value":4}}}]},"search":{"examples":[{"summary":"Search_for_mobility_services_by_pickup_and_drop_location[Buyer_Collecting]___X2","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:40:21.452Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"}}}}},{"summary":"Search_for_mobility_services_by_pickup_and_drop_location[Seller_Collecting]___X1","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"select":{"examples":[{"summary":"Get_quote_for_a_specific_product_from_a_mobility_catalog___X3","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}]},"status":{"examples":[{"summary":"Get_latest_fulfillment_status_of_a_booking___X29","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}},{"summary":"status_buyer_app_requests_the_ride_provider_to_provide_the_latest_order_status_4","description":"TBD","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"ref_id":"870782be-6757-43f1-945c-8eeaf9536259"}}}]},"support":{"examples":[{"summary":"Fetch_support_information_related_to_a_particular_order___X30","value":{"context":{"action":"support","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"support":{"ref_id":"7751bd26-3fdc-47ca-9b64-e998dc5abe68"}}}}]},"track":{"examples":[{"summary":"Track_an_active_ride___X31","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}]}}}},"x-attributes":{"on-demand":{"attribute_set":{"search":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"search","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"}},"message":{"intent":{"fulfillment":{"customer":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the customer gender."}}},"agent":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"Describes the type of the stops during the fulfillment of order"},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"12.923608, 77.614629","description":"Describes the GPS co-ordinates of this location."},"address":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2nd & 3rd Floor, 7/6, August Kranti Marg","description":"Describes the address of the location."},"city":{"code":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code."}},"district":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"New Delhi","description":"Describes the district value."},"country":{"code":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"IND","description":"Describes the country code."}},"area_code":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"110049","description":"Describes the area code."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describe the location of the stop"}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"The list of logical stops encountered during the fulfillment of an order."}},"vehicle":{"category":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle category."},"variant":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"OPTIONAL","type":"object","owner":"BAP","usage":"--","description":"Describes a vehicle is a device that is designed or used to transport people or cargo over land, water, air, or through space.
This has properties like category, capacity, make, model, size,variant,color,energy_type,registration"}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"}},"payment":{"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BPP","description":"This field indicates the payment collector. If set to 'bap,' BAP collects first and settles with BPP. If BPP agrees, no payment link is sent. If set to 'bpp,' BPP collects payment directly."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"The terms of settlement for this order"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This helps the system to find out the purpose of the user behind choosing any product or service. By using this intent the system can align relevant options from available products or service."}}}},"on_search":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_search","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"catalog":{"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Mobility Servies BPP","description":"Describes the catalog name."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the catalog's descriptor."}},"providers":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unique Id of the provider."},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"locations":{"id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Indicates provider locations where this item is available."},"gps":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"28.707358, 77.180910","description":"Describes the GPS co-ordinates of this location."},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's locations."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Describes the unique reference ID to the fulfillment of an order"},"customer":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the customer gender."}}},"agent":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."}}},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DELIVERY","description":"A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. "},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"Describes the type of the stops during the fulfillment of order"},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.707358, 77.180910","description":"Describes the GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle category."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"energy_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"CAB","description":"Describes the vehicle energy type."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"}},"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"CAB Economy Ride","description":"Describes the unique code value of the item"},"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the name value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value of price in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value price in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Indicates the locations where this item is available from providers."},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Describes the Unique reference ID for order fulfillment."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"payments":{"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BPP","description":"This field indicates who is the collector of payment. "},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the terms of settlement between the BAP and the BPP for a single transaction"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Denotes settlement amount"}}}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the catalog's description."}}}},"select":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"select","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This decription refers to the comprehensive list of the products or services selected and obtained within the specified order."}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unique Id of the provider."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This describes the complete formulated description of the loan provider whose catalog items have been selected."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the legal contract created between the buyer and the seller."}}}},"on_select":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_select","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the unique code value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value of price in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value of price in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Provider Locations this item is available in"},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unique Id of the provider."},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"DELIVERY","description":"A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. "},"customer":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the customer gender."}}},"agent":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"Describes the type of the stops during the fulfillment of order"},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"Describes the GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle category."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"energy_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"CAB","description":"Describes the vehicle energy type."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency to be paid in of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the order description."}}}},"init":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"init","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This decription refers to the comprehensive list of the products or services selected and obtained within the specified order."}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Id of the provider"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This describes the complete formulated description of the loan provider whose catalog items have been selected."}},"billing":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"John Doe","description":"Name of the billable entity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"The billing details of this order"}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes contact of end-customer"}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes contact of end-customer"}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.707358, 77.180910","description":"The GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes vehicle category"},"variant":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"OPTIONAL","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"}},"payments":{"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Payment status"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Payment Type"},"params":{"bank_code":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the payment params for this order."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"The terms of settlement for this order"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"This refers to the complete description of the legal contract created between the buyer and the seller."}}}},"on_init":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_init","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145-4ea3-45fe-ab3d-7bcf6b9f456b","description":"Describes the unique Id of the item."},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the unique code value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of selected item."},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value of price in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value of price in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Indicates the locations where this item is available from providers."},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unqiue Id of the provider"},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DELIVERY","description":"A code that describes the mode of fulfillment."},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"Describes the GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle category."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"energy_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"CAB","description":"Describes the vehicle energy type."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Describes the name of the customer"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Describes the contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"}}},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency to be paid in of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the price of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Describes the ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Describe the payment Status for particular order"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Describe the payment type for particular order"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the payment params for this order."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"The terms of settlement for this order"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."},"id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."}}}},"confirm":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"confirm","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This decription refers to the comprehensive list of the products or services selected and obtained within the specified order."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the uique Id of the provider."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This describes the complete formulated description of the loan provider whose catalog items have been selected."}},"billing":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"John Doe","description":"Describes the Name of the billable entity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"The billing details of this order"}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"bc08edb1","description":"ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Describe the payment Status for particular order"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Describe the payment type for particular order"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"transaction_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"cda41144","description":"Describes transaction ID associated with payment activity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the payment params for this order."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"The terms of settlement for this order"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Describe the name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes contact of end-customer"}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Describe the contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes contact of end-customer"}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"Describes the type of the stops during the fulfillment of order"},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"The GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes vehicle category"},"variant":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"OPTIONAL","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"This refers to the complete description of the legal contract created between the buyer and the seller."},"id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."}}}},"on_confirm":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_confirm","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Single Journey Ticket","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"SJT","description":"Describes the unique code value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type to be paid in of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Indicates the locations where this item is available from providers."},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"P1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Unique reference ID to the payment of an order"},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"P1","description":"Unique reference ID to the payment of an order"},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Describes the name of the customer"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Describes the contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"John Doe","description":"Describes the name of the agent"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"},"image":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/images","description":"Describes the agent image"},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the size type of image"}},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the agent details."}},"rating":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"5","description":"Describes the agent rating."},"contact":{"phone":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":7845981268,"description":"Describes the contact number of the agent"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent."}},"state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ASSIGNED","description":"Describes the state's code for fulfillment."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the fulfillments description."}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"INTERMEDIATE_STOP","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.707358, 77.180910","description":"The GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"authorization":{"type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"OTP","description":"Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy."},"token":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":232312,"description":"Token used for authorization. This is typically generated at the BPP. The BAP can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering."},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the authorization for a fulfillments stop."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"AUTO_RICKSHAW","description":"Describes vehicle category"},"make":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Bajaj","description":"Describes vehicle manufacturer"},"model":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"compact-re","description":"Describes vehicle model"},"registration":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"HR-20AS-4578","description":"Describes vehicle registration details"},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency to be paid in of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Describes the ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Describe the Payment Status"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Describe the Payment type"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"amount":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":146,"description":"Describes the amount associated with the payment transaction"},"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency associated with the payment transaction"},"transaction_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"cda41144","description":"Describes transaction ID associated with payment activity"}},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"status":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ACTIVE","description":"Describes the order status."},"created_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes the date-time of creation of this order"},"updated_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes The date-time of updated of this order"},"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."}}}},"cancel":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"cancel","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"60253df1","description":"Describes the unique ID of the order. "},"cancellation_reason_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"45dd6fd3","description":"Describes the reason Id for cancellation"},"descriptor":{"short_desc":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"Accidantaly book the ride","description":"Describes the Short description for cancellaion"},"name":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"Ride Cancellation","description":"Describes the name for cancellaion"},"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"SOFT_CANCEL","description":"Describes the code for cancellaion"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This include the details about the distinctive features, benefits, or unique aspects of the products or service that has been offered to the end customer."}}}},"on_cancel":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_cancel","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique ID of the order. "},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the unique code value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Describes the unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Describes the unique reference ID to the payment of an order"},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Provider Locations this item is available in"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type to be paid in of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unique ID of the provider."},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"Describes a GPS coordinate"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"authorization":{"type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"OTP","description":"Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy."},"token":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":232312,"description":"Token used for authorization. This is typically generated at the BPP. The BAP can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering."}},"time":{"duration":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"PT2H","description":"Describes the duration."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the fulfillments stops."}},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"John Doe","description":"Describes the name of the agent"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"},"image":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/images","description":"Describes the agent image"},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the size type of image"}},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the agent details."}},"rating":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"5","description":"Describes the agent rating."},"contact":{"phone":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":7845981268,"description":"Describes the contact number of the agent"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent."}},"vehicle":{"registration":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"HR-20AS-4578","description":"Describes vehicle registration details"},"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"AUTO_RICKSHAW","description":"Describes vehicle category"},"make":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Bajaj","description":"Describes vehicle manufacturer"},"model":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"compact-re","description":"Describes vehicle model"},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the vehicle type."}},"state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DRIVER_ENROUTE","description":"Describes the state's code for fulfillment."},"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Driver is on the way","description":"Describes the current state"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the fulfillments description."}}},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"P1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Describes the Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency type of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"ID of the payment term that can be referred at an item or an order level in a catalog"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Describe the Payment type"},"params":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes currency value in string form"},"amount":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":60,"description":"Describes a numerical value in decimal form"},"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"bank_account_name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Raghvinder J","description":"Describes the Bank account holder name"},"virtual_payment_address":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"}},"time":{"duration":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P1D","description":"Describes time transaction duration"}},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Describe the Payment Status"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."},"status":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"SOFT_CANCEL","description":"Describes the order status."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."},"documents":{"descriptor":{"code":{"required":"OPTIONAL","usage":"INVOICE","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"string"},"name":{"required":"OPTIONAL","usage":"Invoice Document","description":"It refers to the specific name of the document","owner":"BPP","type":"string"},"short_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the concised description of the document","owner":"BPP","type":"string"},"long_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the brief description of the document","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"object"}},"mime_type":{"required":"OPTIONAL","usage":"application/pdf","description":"It refers to the categorization of the document based on its file format and content type.","owner":"BPP","type":"string"},"url":{"required":"OPTIONAL","usage":"https://seller.com/loan/invoice/O1.pdf","description":"This describes the url from where the document can be accessed","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the set of documents that are associated to a particular order","owner":"BPP","type":"object"}}}}},"status":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"status","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"60253df1","description":"Describes the unique ID of the order. "},"ref_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"60253df1","description":"Describes unique id for reference, pre-order this will be transaction ID."}}},"on_status":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_status","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique ID of the item. "},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the item code."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes a numerical value in decimal form"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Provider Locations this item is available in"},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Id of the provider"},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"28.686576, 77.441632","description":"Describes a GPS coordinate"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"CAB","description":"Describes vehicle category"},"make":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Bajaj","description":"Describes vehicle manufacturer"},"model":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"compact-re","description":"Describes vehicle model"},"registration":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"HR-20AS-4578","description":"Describes vehicle registration details"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the vehicle type."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."}},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Jason Roy","description":"Name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BPP","usage":9898657512,"description":"Contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"John Doe","description":"Describes the name of the agent"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"},"image":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/images","description":"Describes the agent image"},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the size type of image"}},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the agent details."}},"rating":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"5","description":"Describes the agent rating."},"contact":{"phone":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":7845981268,"description":"Describes the contact number of the agent"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent."}},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Delivery","description":"Describes type of fullfilment"},"state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DRIVER_ENROUTE","description":"Describes the state's code for fulfillment."},"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Driver is on the way","description":"Describes the current state"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the fulfillments description."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency to be paid in of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"PA1","description":"ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Payment Status"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Payment type"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"transaction_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"cda41144","description":"Describes transaction ID associated with payment activity"},"amount":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":146,"description":"Describes the amount associated with the payment transaction"},"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency associated with the payment transaction"}},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"status":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"ACTIVE","description":"Describes the order status."},"created_at":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes the date-time of creation of this order"},"updated_at":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes The date-time of updated of this order"},"id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."},"documents":{"descriptor":{"code":{"required":"OPTIONAL","usage":"INVOICE","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"string"},"name":{"required":"OPTIONAL","usage":"Invoice Document","description":"It refers to the specific name of the document","owner":"BPP","type":"string"},"short_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the concised description of the document","owner":"BPP","type":"string"},"long_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the brief description of the document","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"object"}},"mime_type":{"required":"OPTIONAL","usage":"application/pdf","description":"It refers to the categorization of the document based on its file format and content type.","owner":"BPP","type":"string"},"url":{"required":"OPTIONAL","usage":"https://seller.com/loan/invoice/O1.pdf","description":"This describes the url from where the document can be accessed","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the set of documents that are associated to a particular order","owner":"BPP","type":"object"}}}}},"update":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_status","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":1,"description":"Describes the unique order id"},"fulfillments":{"customer":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"John Adam","description":"Name of the customer"}}},"_description":{"required":"OPTIONAL","type":"object","owner":"BAP/BPP","usage":"--","description":"Name of the customer"}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the unique order id"}}}},"on_update":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_update","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique ID of the item. "},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name. "},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the item code. "},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes a numerical value in decimal form"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Provider Locations this item is available in"},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Id of the provider"},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"Describes a GPS coordinate"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the location of stops."}},"authorization":{"type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"OTP","description":"Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy."},"token":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":232312,"description":"Token used for authorization. This is typically generated at the BPP. The BAP can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering."},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the authorization for a fulfillments stop."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes vehicle category"},"make":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Bajaj","description":"Describes vehicle manufacturer"},"model":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"compact-re","description":"Describes vehicle model"},"registration":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"HR-20AS-4578","description":"Describes vehicle registration details"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."}},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"John Adam","description":"Name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"John Doe","description":"Describes the name of the agent"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"},"image":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/images","description":"Describes the agent image"},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the size type of image"}},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the agent details."}},"rating":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"5","description":"Describes the agent rating."},"contact":{"phone":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":7845981268,"description":"Describes the contact number of the agent"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent."}},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Delivery","description":"Describes type of fullfilment"},"state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DRIVER_ENROUTE","description":"Describes the state's code for fulfillment."},"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Driver is on the way","description":"Describes the current state"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the fulfillments description."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency to be paid in of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"PA1","description":"ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Payment Status"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Payment type"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"}},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"status":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"COMPLETED","description":"Describes the order status."},"created_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes the date-time of creation of this order"},"updated_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes The date-time of updated of this order"},"billing":{"name":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"John Doe","description":"Describes the Name of the billable entity"},"email":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"jane.doe@example.com","description":"Describes the email of the billable entity"},"phone":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":9897867564,"description":"Describes the contact number of the billable entity"}},"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."},"documents":{"descriptor":{"code":{"required":"OPTIONAL","usage":"INVOICE","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"string"},"name":{"required":"OPTIONAL","usage":"Invoice Document","description":"It refers to the specific name of the document","owner":"BPP","type":"string"},"short_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the concised description of the document","owner":"BPP","type":"string"},"long_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the brief description of the document","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"object"}},"mime_type":{"required":"OPTIONAL","usage":"application/pdf","description":"It refers to the categorization of the document based on its file format and content type.","owner":"BPP","type":"string"},"url":{"required":"OPTIONAL","usage":"https://seller.com/loan/invoice/O1.pdf","description":"This describes the url from where the document can be accessed","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the set of documents that are associated to a particular order","owner":"BPP","type":"object"}}}}},"track":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"track","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"O1","description":"Describes the order ID."}}},"on_track":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_track","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"tracking":{"status":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"O1","description":"Describes the order status."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"28.620976, 77.046732","description":"Describes the gps value."},"updated_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-03-23T05:41:09Z","description":"Describes the updated_at value."}}}}}}}},"x-errorcodes":{"code":[{"Event":"Route Serviceability error","Description":"To & from location not serviceable by Seller application","From":"BPP","code":90201},{"Event":"Tracking not enabled","Description":"Tracking not enabled for any fulfillment in the order","From":"BPP","code":90202},{"Event":"Driver not assigned","Description":"Driver not assigned to the order","From":"BPP","code":90203}]},"x-tlc":{"code":[{"Term":"Payment Collector ","Api":"search/on_search/init/on_init\t","Attribute":"payment.collected_by ","Owner":"Either","Value":"“BAP”, “BPP” ","Description":"If set to “BAP”, it means that the Buyer App will collect payment from the Buyer.\nIf set to “BPP”, it means that the Seller App will collect payment from the Buyer."},{"Term":"Payment Type ","Api":"init/on_init ","Attribute":"payment.type ","Owner":"Either","Value":"“ON-ORDER”, “ON_FULFILLMENT”\n","Description":"How payment is going to be collected from the Buyer. If this parameter is set to “ON-ORDER”, that means it is a pre-paid order, i.e. the payment is collected at the time of order confirmation. If this parameter is set to “ON_FULFILLMENT”, that means it is a pay at the end of the trip, i.e. the payment is collected when the trip ends."},{"Term":"Item Cancellability ","Api":"search/on_search/init/on_init\t","Attribute":"Handled in cancellation terms ","Owner":"Seller App\t","Value":"true/ false\t","Description":"Whether the order for that item can be canceled after being confirmed. If set to “TRUE” that means the Seller allows the Buyer to cancel the order for the item in question, after confirmation."},{"Term":"Static Terms","Api":"search/on_search/init/on_init\t","Attribute":"STATIC_TERMS","Owner":"Seller App & Buyer App","Value":"URL","Description":"This will be the URL of a web-page where the standard Terms and Conditions of the Network Participant - which are not covered in the API Specification (e.g.: indemnity) - will be hosted. These terms will apply to the transaction, in addition to the terms decided through the ONDC Protocol. If there is a conflict between the terms decided through the Protocol, and the Static Terms, the terms decided through the ONDC Protocol will prevail. Also, if there is a conflict between the Static Terms and the ONDC Network Policy or the Static Terms and the Network Participant Agreement, the terms of the ONDC Network Policy or the Network Participant Agreement (as the case may be) will prevail."}]},"x-featureui":{"filenames":["document_sharing.md"]},"x-sandboxui":{"dropdown":[{"environment-name":"staging","link":"https://mobility-staging.ondc.org"}]},"x-changeLog":{"filenames":["TRV10_2.1.0_030924.md"]}} \ No newline at end of file From 436ee601b43bf3301329aadec25a2fc59f84432f Mon Sep 17 00:00:00 2001 From: Anuj Sharma Date: Mon, 17 Aug 2026 11:46:36 +0530 Subject: [PATCH 2/4] feat: resolved conflicts --- .../docs/changeLog/TRV10_2.1.0_030924.md | 23 ++++++++----------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/api/components/docs/changeLog/TRV10_2.1.0_030924.md b/api/components/docs/changeLog/TRV10_2.1.0_030924.md index 097bfc42..9a91ac05 100644 --- a/api/components/docs/changeLog/TRV10_2.1.0_030924.md +++ b/api/components/docs/changeLog/TRV10_2.1.0_030924.md @@ -112,20 +112,15 @@ - Enabled `creds` for agent to share additional info. ****17th Aug 2026**** - - Added cancellation code 999 for "Others". When cancellation code 999 is used, short_desc is mandatory to specify the cancellation reason - ``` - cancellation: - reason: - descriptor: - code: "999" - short_desc: "Customer requested cancellation" - ``` - - + - Added cancellation code 999 for "Others". When cancellation code 999 is used, short_desc is mandatory to specify the cancellation reason. + For example: + ```cancellation: + reason: + descriptor: + code: "999" + short_desc: "Customer requested cancellation" + ``` - - - - +--- \ No newline at end of file From fedde393fa2794314c13c6788e5c07773b8a9034 Mon Sep 17 00:00:00 2001 From: Anuj Sharma Date: Mon, 17 Aug 2026 14:39:08 +0530 Subject: [PATCH 3/4] feat: added enums for support/on_support --- api/build/build.yaml | 1644 ++++++++++++------------ api/components/enum/default/index.yaml | 133 +- ui/build.js | 2 +- 3 files changed, 912 insertions(+), 867 deletions(-) diff --git a/api/build/build.yaml b/api/build/build.yaml index 6ca578a4..ce69ab24 100644 --- a/api/build/build.yaml +++ b/api/build/build.yaml @@ -3241,64 +3241,54 @@ x-enum: location: *ref_0 domain: *ref_1 message: - cancellation: - reason: - descriptor: - code: &ref_10 - - code: '000' - description: >- - Technical cancellation of orders in case protocol technical - failures(BAP/BPP) - reference: - - Seller app cannot confirm the ride as no drivers are - available(BPP) - reference: - - Describes the cancellation reason as "Others" when none of the - predefined cancellation reasons apply. - reference: - + Technical cancellation of orders in case protocol technical + failures(BAP/BPP) + reference: location: *ref_0 domain: *ref_1 + support: + context: + action: + - code: support + description: Buyer app requests order support." + reference: + location: *ref_0 + domain: *ref_1 + message: + support: + descriptor: &ref_12 + code: + - code: SOS + description: Describes the support code value as SOS + reference: + - code: LONG_HALT + description: Describes the support code value as LONG_HALT + reference: + - code: ROUTE_DEV + description: Describes the support code value as ROUTE_DEV + reference: + on_support: + context: + action: + - code: on_support + description: Buyer app requests order support." + reference: + location: *ref_0 + domain: *ref_1 + message: + support: + descriptor: *ref_12 x-tags: search: message: intent: - tags: &ref_24 - - &ref_27 + tags: &ref_25 + - &ref_28 code: BAP_TERMS description: Describes the finder fees for buyer reference: @@ -3391,7 +3413,7 @@ x-tags: - code: DISABILITY_VIS description: Describes the Vision Impairment reference: - list: &ref_12 + list: &ref_13 - code: VIS_LEVEL description: Describes the Level of Disability reference: @@ -3434,7 +3456,7 @@ x-tags: - code: DISABILITY_HEA description: Describes the Hearing Impairment reference: - list: &ref_13 + list: &ref_14 - code: HEA_READING_ABILITY description: Describes the Reading Ability reference: @@ -3467,7 +3489,7 @@ x-tags: - code: DISABILITY_MOB description: Describes the Disability of movement reference: - list: &ref_14 + list: &ref_15 - code: MOB_DISABILITY description: Describes the mob disability reference: @@ -3519,21 +3541,21 @@ x-tags: - code: DISABILITY_LEP description: Describes the Leprosy Cured reference: - list: &ref_15 + list: &ref_16 - code: LEP_SPECIAL_REQUIREMENT description: Describes the special requirement reference: - code: DISABILITY_SPE description: Describes the Speech and Language Disability reference: - list: &ref_16 + list: &ref_17 - code: SPE_SPECIAL_REQUIREMENT description: Describes the special requirement reference: - code: DISABILITY_INTEL description: Describes the Intellectual Disability reference: - list: &ref_17 + list: &ref_18 - code: INTEL_DISABILITY description: Describes the Intellectual Disability reference: @@ -3556,7 +3578,7 @@ x-tags: - code: MENTAL description: Describes the Mental Illness reference: - list: &ref_18 + list: &ref_19 - code: MENTAL_DISABILITY description: Describes the Mental Disability reference: @@ -3579,7 +3601,7 @@ x-tags: - code: DISABILITY_BLOOD description: Describes the Blood Related Disorders reference: - list: &ref_19 + list: &ref_20 - code: BLOOD_DISABILITY description: Describes the blood Disability reference: @@ -3602,29 +3624,29 @@ x-tags: - code: DISABILITY_DWARFISM description: Describes the Dwarfism reference: - list: &ref_20 + list: &ref_21 - code: DWARFISM_SPECIAL_REQUIREMENT description: Describes the special requirement reference: - code: DISABILITY_ACID_ATTACK_SURVIVOR description: Describes the Acid Attack Survivor reference: - list: &ref_21 + list: &ref_22 - code: ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT description: Describes the special requirement reference: - code: DISABILITY_MULTIPLE_DIS description: Describes the Multiple Disabilities reference: - list: &ref_22 + list: &ref_23 - code: ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT description: Describes the special requirement reference: on_search: message: catalog: - tags: &ref_25 - - &ref_28 + tags: &ref_26 + - &ref_29 code: BPP_TERMS description: Describes the finder fees for buyer reference: @@ -3639,52 +3661,52 @@ x-tags: can be true or false reference: providers: - items: &ref_23 + items: &ref_24 tags: - code: DISABILITY_VIS description: Describes the Vision Impairment reference: - list: *ref_12 + list: *ref_13 - code: DISABILITY_HEA description: Describes the Hearing Impairment reference: - list: *ref_13 + list: *ref_14 - code: DISABILITY_MOB description: Describes the Disability of movement reference: - list: *ref_14 + list: *ref_15 - code: DISABILITY_LEP description: Describes the Leprosy Cured reference: - list: *ref_15 + list: *ref_16 - code: DISABILITY_SPE description: Describes the Speech and Language Disability reference: - list: *ref_16 + list: *ref_17 - code: DISABILITY_INTEL description: Describes the Intellectual Disability reference: - list: *ref_17 + list: *ref_18 - code: MENTAL description: Describes the Mental Illness reference: - list: *ref_18 + list: *ref_19 - code: DISABILITY_BLOOD description: Describes the Blood Related Disorders reference: - list: *ref_19 + list: *ref_20 - code: DISABILITY_DWARFISM description: Describes the Dwarfism reference: - list: *ref_20 + list: *ref_21 - code: DISABILITY_ACID_ATTACK_SURVIVOR description: Describes the Acid Attack Survivor reference: - list: *ref_21 + list: *ref_22 - code: DISABILITY_MULTIPLE_DIS description: Describes the Multiple Disabilities reference: - list: *ref_22 + list: *ref_23 - code: FARE_POLICY description: Details about fare for the ride reference: @@ -3735,8 +3757,8 @@ x-tags: on_select: message: order: - items: *ref_23 - fulfillments: &ref_26 + items: *ref_24 + fulfillments: &ref_27 tags: - code: ROUTE_INFO description: Describes the route information. @@ -3751,25 +3773,25 @@ x-tags: init: message: order: - tags: *ref_24 + tags: *ref_25 on_init: message: order: - tags: *ref_25 - items: *ref_23 - fulfillments: *ref_26 - confirm: &ref_29 + tags: *ref_26 + items: *ref_24 + fulfillments: *ref_27 + confirm: &ref_30 message: order: tags: - - *ref_27 - *ref_28 - items: *ref_23 - fulfillments: *ref_26 - on_confirm: *ref_29 - on_status: *ref_29 - on_cancel: *ref_29 - on_update: *ref_29 + - *ref_29 + items: *ref_24 + fulfillments: *ref_27 + on_confirm: *ref_30 + on_status: *ref_30 + on_cancel: *ref_30 + on_update: *ref_30 x-flows: - summary: On-Demand - Assign driver on on-confirm details: @@ -3852,7 +3874,7 @@ x-flows: summary: >- Search for mobility services by pickup and drop location[Seller Collecting] - value: &ref_30 + value: &ref_31 context: action: search bap_id: example-bap.com @@ -3933,7 +3955,7 @@ x-flows: reference: if any example: summary: Return a mobility catalog[Seller Collecting] - value: &ref_45 + value: &ref_46 context: action: on_search bap_id: example-bap.com @@ -4171,7 +4193,7 @@ x-flows: reference: if any example: summary: Get quote for a specific product from a mobility catalog - value: &ref_46 + value: &ref_47 context: action: select bap_id: example-bap.com @@ -4216,7 +4238,7 @@ x-flows: reference: if any example: summary: Return a quote offered by a provider - value: &ref_47 + value: &ref_48 context: action: on_select bap_id: example-bap.com @@ -4416,7 +4438,7 @@ x-flows: summary: >- Initialize draft order and request for terms of service[Seller Collecting] - value: &ref_48 + value: &ref_49 context: action: init bap_id: example-bap.com @@ -4494,7 +4516,7 @@ x-flows: reference: if any example: summary: Return draft order with payment terms[Seller Collecting] - value: &ref_49 + value: &ref_50 context: action: on_init bap_id: example-bap.com @@ -4718,7 +4740,7 @@ x-flows: reference: if any example: summary: Confirm ride booking - value: &ref_50 + value: &ref_51 context: action: confirm bap_id: example-bap.com @@ -4810,7 +4832,7 @@ x-flows: reference: if any example: summary: Return confirmed order with latest fulfillment details - value: &ref_54 + value: &ref_55 context: action: on_confirm bap_id: example-bap.com @@ -5079,7 +5101,7 @@ x-flows: reference: if any example: summary: Return updated order with updated agent details - value: &ref_55 + value: &ref_56 context: action: on_status bap_id: example-bap.com @@ -5348,7 +5370,7 @@ x-flows: reference: if any example: summary: Track an active ride - value: &ref_31 + value: &ref_32 context: action: track bap_id: example-bap.com @@ -5387,7 +5409,7 @@ x-flows: reference: if any example: summary: Return tracking information for an order - value: &ref_32 + value: &ref_33 context: action: on_track bap_id: example-bap.com @@ -5429,7 +5451,7 @@ x-flows: reference: if any example: summary: Return updated order with updated agent details - value: &ref_52 + value: &ref_53 context: action: on_status bap_id: example-bap.com @@ -5696,7 +5718,7 @@ x-flows: reference: if any example: summary: Return updated order with updated agent details - value: &ref_53 + value: &ref_54 context: action: on_status bap_id: example-bap.com @@ -5967,7 +5989,7 @@ x-flows: reference: if any example: summary: Return updated order with recomputed charges - value: &ref_86 + value: &ref_87 context: action: on_update bap_id: example-bap.com @@ -6227,7 +6249,7 @@ x-flows: reference: if any example: summary: Get latest fulfillment status of a booking - value: &ref_33 + value: &ref_34 context: action: status bap_id: example-bap.com @@ -6266,7 +6288,7 @@ x-flows: reference: if any example: summary: Return order with status - Driver at pickup - value: &ref_84 + value: &ref_85 context: action: on_status bap_id: example-bap.com @@ -6612,7 +6634,7 @@ x-flows: summary: >- Search for mobility services by pickup and drop location[Seller Collecting] - value: *ref_30 + value: *ref_31 - summary: Get a list of all services from ride providers api: on_search details: @@ -8123,7 +8145,7 @@ x-flows: reference: if any example: summary: Track an active ride - value: *ref_31 + value: *ref_32 - summary: Provider platform provides latest order tracking status api: on_track details: @@ -8143,7 +8165,7 @@ x-flows: reference: if any example: summary: Return tracking information for an order - value: *ref_32 + value: *ref_33 - summary: Ride provider provides latest order status api: on_status details: @@ -8975,7 +8997,7 @@ x-flows: reference: if any example: summary: Get latest fulfillment status of a booking - value: *ref_33 + value: *ref_34 - summary: Ride provider provides latest order status api: on_status details: @@ -9346,7 +9368,7 @@ x-flows: summary: >- Search for mobility services by pickup and drop location[BAP Collecting] - value: &ref_34 + value: &ref_35 context: action: search bap_id: example-bap.com @@ -9427,7 +9449,7 @@ x-flows: reference: if any example: summary: Return a mobility catalog[BAP Collecting] - value: &ref_35 + value: &ref_36 context: action: on_search bap_id: example-bap.com @@ -9655,7 +9677,7 @@ x-flows: reference: if any example: summary: Get quote for a specific product from a mobility catalog - value: &ref_36 + value: &ref_37 context: action: select bap_id: example-bap.com @@ -9700,7 +9722,7 @@ x-flows: reference: if any example: summary: Return a quote offered by a provider - value: &ref_37 + value: &ref_38 context: action: on_select bap_id: example-bap.com @@ -10810,7 +10832,7 @@ x-flows: reference: if any example: summary: Track an active ride - value: *ref_31 + value: *ref_32 - summary: Provider platform provides latest order tracking status api: on_track details: @@ -10830,7 +10852,7 @@ x-flows: reference: if any example: summary: Return tracking information for an order - value: *ref_32 + value: *ref_33 - summary: Ride provider provides latest order status api: on_status details: @@ -11998,7 +12020,7 @@ x-flows: summary: >- Search for mobility services by pickup and drop location[BAP Collecting] - value: *ref_34 + value: *ref_35 - summary: Get a list of all services from ride providers api: on_search details: @@ -12021,7 +12043,7 @@ x-flows: reference: if any example: summary: Return a mobility catalog[BAP Collecting] - value: *ref_35 + value: *ref_36 - summary: Buyer app selects a specific service for more details api: select details: @@ -12041,7 +12063,7 @@ x-flows: reference: if any example: summary: Get quote for a specific product from a mobility catalog - value: *ref_36 + value: *ref_37 - summary: Ride provider provides the quote for selected service api: on_select details: @@ -12061,7 +12083,7 @@ x-flows: reference: if any example: summary: Return a quote offered by a provider - value: *ref_37 + value: *ref_38 - summary: Buyer app initializes the ride request api: init details: @@ -12083,7 +12105,7 @@ x-flows: summary: >- Initialize draft order and request for terms of service[BAP Collecting] - value: &ref_38 + value: &ref_39 context: action: init bap_id: example-bap.com @@ -12161,7 +12183,7 @@ x-flows: reference: if any example: summary: Return draft order with payment terms[BAP Collecting] - value: &ref_39 + value: &ref_40 context: action: on_init bap_id: example-bap.com @@ -12385,7 +12407,7 @@ x-flows: reference: if any example: summary: Confirm ride booking - value: &ref_40 + value: &ref_41 context: action: confirm bap_id: example-bap.com @@ -12481,7 +12503,7 @@ x-flows: reference: if any example: summary: Return confirmed order with latest fulfillment details - value: &ref_41 + value: &ref_42 context: action: on_confirm bap_id: example-bap.com @@ -12743,7 +12765,7 @@ x-flows: reference: if any example: summary: Return updated order with updated agent details - value: &ref_42 + value: &ref_43 context: action: on_status bap_id: example-bap.com @@ -13005,7 +13027,7 @@ x-flows: reference: if any example: summary: Track an active ride - value: *ref_31 + value: *ref_32 - summary: Provider platform provides latest order tracking status api: on_track details: @@ -13025,7 +13047,7 @@ x-flows: reference: if any example: summary: Return tracking information for an order - value: *ref_32 + value: *ref_33 - summary: Ride provider provides latest order status api: on_status details: @@ -13044,7 +13066,7 @@ x-flows: reference: if any example: summary: Return updated order with updated agent details - value: &ref_43 + value: &ref_44 context: action: on_status bap_id: example-bap.com @@ -13304,7 +13326,7 @@ x-flows: reference: if any example: summary: Return updated order with updated agent details - value: &ref_44 + value: &ref_45 context: action: on_status bap_id: example-bap.com @@ -13821,7 +13843,7 @@ x-flows: reference: if any example: summary: Get latest fulfillment status of a booking - value: *ref_33 + value: *ref_34 - summary: Ride provider provides latest order status api: on_status details: @@ -14154,7 +14176,7 @@ x-flows: summary: >- Search for mobility services by pickup and drop location[BAP Collecting] - value: *ref_34 + value: *ref_35 - summary: Get a list of all services from ride providers api: on_search details: @@ -14177,7 +14199,7 @@ x-flows: reference: if any example: summary: Return a mobility catalog[BAP Collecting] - value: *ref_35 + value: *ref_36 - summary: Buyer app selects a specific service for more details api: select details: @@ -14197,7 +14219,7 @@ x-flows: reference: if any example: summary: Get quote for a specific product from a mobility catalog - value: *ref_36 + value: *ref_37 - summary: Ride provider provides the quote for selected service api: on_select details: @@ -14217,7 +14239,7 @@ x-flows: reference: if any example: summary: Return a quote offered by a provider - value: *ref_37 + value: *ref_38 - summary: Buyer app initializes the ride request api: init details: @@ -14239,7 +14261,7 @@ x-flows: summary: >- Initialize draft order and request for terms of service[BAP Collecting] - value: *ref_38 + value: *ref_39 - summary: Ride provider accepts/appends the terms of orders api: on_init details: @@ -14259,7 +14281,7 @@ x-flows: reference: if any example: summary: Return draft order with payment terms[BAP Collecting] - value: *ref_39 + value: *ref_40 - summary: Buyer app confirms the ride api: confirm details: @@ -14281,7 +14303,7 @@ x-flows: reference: if any example: summary: Confirm ride booking - value: *ref_40 + value: *ref_41 - summary: Ride provider confirms the ride request api: on_confirm details: @@ -14303,7 +14325,7 @@ x-flows: reference: if any example: summary: Return confirmed order with latest fulfillment details - value: *ref_41 + value: *ref_42 - summary: Ride provider provides latest order status api: on_status details: @@ -14323,7 +14345,7 @@ x-flows: reference: if any example: summary: Return updated order with updated agent details - value: *ref_42 + value: *ref_43 - summary: Buyer app requests for tracking status api: track details: @@ -14343,7 +14365,7 @@ x-flows: reference: if any example: summary: Track an active ride - value: *ref_31 + value: *ref_32 - summary: Provider platform provides latest order tracking status api: on_track details: @@ -14363,7 +14385,7 @@ x-flows: reference: if any example: summary: Return tracking information for an order - value: *ref_32 + value: *ref_33 - summary: Ride provider provides latest order status api: on_status details: @@ -14382,7 +14404,7 @@ x-flows: reference: if any example: summary: Return updated order with updated agent details - value: *ref_43 + value: *ref_44 - summary: Ride provider provides latest order updates api: on_status details: @@ -14400,7 +14422,7 @@ x-flows: reference: if any example: summary: Return updated order with updated agent details - value: *ref_44 + value: *ref_45 - summary: >- Ride provider provides latest update on the ride with updated fare details (unsolicited call) @@ -15054,7 +15076,7 @@ x-flows: summary: >- Search for mobility services by pickup and drop location[Seller Collecting] - value: *ref_30 + value: *ref_31 - summary: Get a list of all services from ride providers api: on_search details: @@ -15077,7 +15099,7 @@ x-flows: reference: if any example: summary: Return a mobility catalog[Seller Collecting] - value: *ref_45 + value: *ref_46 - summary: Buyer app selects a specific service for more details api: select details: @@ -15097,7 +15119,7 @@ x-flows: reference: if any example: summary: Get quote for a specific product from a mobility catalog - value: *ref_46 + value: *ref_47 - summary: Ride provider provides the quote for selected service api: on_select details: @@ -15117,7 +15139,7 @@ x-flows: reference: if any example: summary: Return a quote offered by a provider - value: *ref_47 + value: *ref_48 - summary: Buyer app initializes the ride request api: init details: @@ -15139,7 +15161,7 @@ x-flows: summary: >- Initialize draft order and request for terms of service[Seller Collecting] - value: *ref_48 + value: *ref_49 - summary: Ride provider accepts/appends the terms of orders api: on_init details: @@ -15159,7 +15181,7 @@ x-flows: reference: if any example: summary: Return draft order with payment terms[Seller Collecting] - value: *ref_49 + value: *ref_50 - summary: Buyer app confirms the ride api: confirm details: @@ -15179,7 +15201,7 @@ x-flows: reference: if any example: summary: Confirm ride booking - value: *ref_50 + value: *ref_51 - summary: Ride provider confirms the ride request api: on_confirm details: @@ -15199,7 +15221,7 @@ x-flows: reference: if any example: summary: Return confirmed order with latest fulfillment details - value: &ref_57 + value: &ref_58 context: action: on_confirm bap_id: example-bap.com @@ -15426,7 +15448,7 @@ x-flows: reference: if any example: summary: Return updated order with updated agent details - value: &ref_87 + value: &ref_88 context: action: on_update bap_id: example-bap.com @@ -15666,7 +15688,7 @@ x-flows: reference: if any example: summary: Track an active ride - value: *ref_31 + value: *ref_32 - summary: Provider platform provides latest order tracking status api: on_track details: @@ -15686,10 +15708,10 @@ x-flows: reference: if any example: summary: Return tracking information for an order - value: *ref_32 + value: *ref_33 - summary: Ride provider provides latest order status api: on_status - details: &ref_51 + details: &ref_52 - description: Ride provider provides the updated order status to the buyer app mermaid: |- sequenceDiagram @@ -15934,18 +15956,18 @@ x-flows: updated_at: '2023-12-10T08:03:34.294Z' - summary: Ride provider provides latest order status api: on_status - details: *ref_51 + details: *ref_52 reference: if any example: summary: Return updated order with updated agent details - value: *ref_52 + value: *ref_53 - summary: Ride provider provides latest order updates api: on_status - details: *ref_51 + details: *ref_52 reference: if any example: summary: Return updated order with updated agent details - value: *ref_53 + value: *ref_54 - summary: Buyer app seeks the most recent status update api: status details: @@ -15967,14 +15989,14 @@ x-flows: reference: if any example: summary: Get latest fulfillment status of a booking - value: *ref_33 + value: *ref_34 - summary: Ride provider provides latest order status api: on_status - details: *ref_51 + details: *ref_52 reference: if any example: summary: Return order with status - Driver at pickup - value: &ref_81 + value: &ref_82 context: action: on_status bap_id: example-bap.com @@ -16294,7 +16316,7 @@ x-flows: summary: >- Search for mobility services by pickup and drop location[Seller Collecting] - value: *ref_30 + value: *ref_31 - summary: Get a list of all services from ride providers api: on_search details: @@ -16317,7 +16339,7 @@ x-flows: reference: if any example: summary: Return a mobility catalog[Seller Collecting] - value: &ref_79 + value: &ref_80 context: action: on_search bap_id: example-bap.com @@ -16565,7 +16587,7 @@ x-flows: reference: if any example: summary: Return a quote offered by a provider - value: &ref_80 + value: &ref_81 context: action: on_select bap_id: example-bap.com @@ -16750,7 +16772,7 @@ x-flows: summary: >- Initialize draft order and request for terms of service[Seller Collecting] - value: &ref_70 + value: &ref_71 context: action: init bap_id: example-bap.com @@ -16832,7 +16854,7 @@ x-flows: reference: if any example: summary: Return draft order with payment terms[Seller Collecting] - value: &ref_78 + value: &ref_79 context: action: on_init bap_id: example-bap.com @@ -17039,7 +17061,7 @@ x-flows: reference: if any example: summary: Confirm ride booking - value: &ref_67 + value: &ref_68 context: action: confirm bap_id: example-bap.com @@ -17133,7 +17155,7 @@ x-flows: reference: if any example: summary: Return confirmed order with latest fulfillment details - value: &ref_74 + value: &ref_75 context: action: on_confirm bap_id: example-bap.com @@ -17365,7 +17387,7 @@ x-flows: reference: if any example: summary: Return confirmed order with latest fulfillment details - value: &ref_88 + value: &ref_89 context: action: on_update bap_id: example-bap.com @@ -17610,7 +17632,7 @@ x-flows: reference: if any example: summary: Return confirmed order with latest fulfillment details - value: &ref_82 + value: &ref_83 context: action: on_status bap_id: example-bap.com @@ -17853,7 +17875,7 @@ x-flows: reference: if any example: summary: Track an active ride - value: *ref_31 + value: *ref_32 - summary: Provider platform provides latest order tracking status api: on_track details: @@ -17873,7 +17895,7 @@ x-flows: reference: if any example: summary: Return tracking information for an order - value: *ref_32 + value: *ref_33 - summary: Ride provider provides latest update on the ride (unsolicited call) api: on_update details: @@ -17895,7 +17917,7 @@ x-flows: reference: if any example: summary: Return confirmed order with latest fulfillment details - value: &ref_89 + value: &ref_90 context: action: on_update bap_id: example-bap.com @@ -18140,7 +18162,7 @@ x-flows: reference: if any example: summary: Get latest fulfillment status of a booking - value: *ref_33 + value: *ref_34 - summary: Ride provider provides latest order status api: on_status details: @@ -18160,7 +18182,7 @@ x-flows: reference: if any example: summary: Return confirmed order with latest fulfillment details - value: &ref_83 + value: &ref_84 context: action: on_status bap_id: example-bap.com @@ -19088,7 +19110,7 @@ x-flows: reference: if any example: summary: Return current order status after confirm-cancel - value: &ref_71 + value: &ref_72 context: action: on_cancel bap_id: example-bap.com @@ -19365,10 +19387,10 @@ x-flows: reference: if any example: summary: Return confirmed order with latest fulfillment details - value: *ref_54 + value: *ref_55 - summary: Ride provider provides latest order status api: on_status - details: &ref_56 + details: &ref_57 - description: Ride provider provides the updated order status to the buyer app mermaid: |- sequenceDiagram @@ -19385,14 +19407,14 @@ x-flows: reference: if any example: summary: Return updated order with updated agent details - value: *ref_55 + value: *ref_56 - summary: Ride provider provides latest order status api: on_status - details: *ref_56 + details: *ref_57 reference: if any example: summary: Return updated order with updated agent details - value: &ref_65 + value: &ref_66 context: action: on_status bap_id: example-bap.com @@ -19642,7 +19664,7 @@ x-flows: reference: if any example: summary: Initiates cancelling a ride with soft cancel status - value: &ref_61 + value: &ref_62 context: action: cancel bap_id: example-bap.com @@ -19952,7 +19974,7 @@ x-flows: reference: if any example: summary: Initiates cancelling a ride with confirm cancel status - value: &ref_66 + value: &ref_67 context: action: cancel bap_id: example-bap.com @@ -20286,7 +20308,7 @@ x-flows: Buyer Platform (BAP)-->>Seller Platform (BPP): ACK reference: if any example: - value: *ref_54 + value: *ref_55 - summary: Buyer app request for latest order status api: status details: @@ -21247,12 +21269,12 @@ x-flows: reference: if any example: summary: Confirm ride booking - value: *ref_50 + value: *ref_51 - summary: Ride provider confirms the ride request reference: if any api: on_confirm example: - value: &ref_76 + value: &ref_77 context: action: on_confirm bap_id: example-bap.com @@ -21355,12 +21377,12 @@ x-flows: reference: if any example: summary: Confirm ride booking - value: *ref_50 + value: *ref_51 - summary: Ride provider confirms the ride request reference: if any api: on_confirm example: - value: *ref_57 + value: *ref_58 details: - description: >- Ride provider confirms the ride request and provides the ride @@ -21379,7 +21401,7 @@ x-flows: reference: if any api: on_cancel example: - value: &ref_73 + value: &ref_74 context: action: on_cancel bap_id: example-bap.com @@ -23154,7 +23176,7 @@ x-flows: reference: if any example: summary: Track an active ride - value: *ref_31 + value: *ref_32 - summary: Provider platform provides latest order tracking status api: on_track details: @@ -23174,7 +23196,7 @@ x-flows: reference: if any example: summary: Return tracking information for an order - value: *ref_32 + value: *ref_33 - summary: Ride provider provides latest order status api: on_status details: @@ -23937,7 +23959,7 @@ x-flows: reference: if any example: summary: Get latest fulfillment status of a booking - value: *ref_33 + value: *ref_34 - summary: Ride provider provides latest order status api: on_status details: @@ -24279,7 +24301,7 @@ x-flows: reference: if any example: summary: Update an active ride - value: &ref_62 + value: &ref_63 context: action: update bap_id: example-bap.com @@ -24327,7 +24349,7 @@ x-flows: reference: if any example: summary: Return tracking information for an order - value: &ref_63 + value: &ref_64 context: action: on_update bap_id: example-bap.com @@ -25159,7 +25181,7 @@ x-flows: summary: >- Search for mobility services by pickup and drop location[Seller Collecting] - value: *ref_30 + value: *ref_31 - summary: Get a list of all services from ride providers api: on_search details: @@ -25182,7 +25204,7 @@ x-flows: reference: if any example: summary: Return a mobility catalog[Seller Collecting] - value: *ref_45 + value: *ref_46 - summary: Buyer app selects a specific service for more details api: select details: @@ -25497,7 +25519,7 @@ x-flows: reference: if any example: summary: Confirm ride booking - value: *ref_50 + value: *ref_51 - summary: Ride provider confirms the ride request api: on_confirm details: @@ -25519,7 +25541,7 @@ x-flows: reference: if any example: summary: Return confirmed order with latest fulfillment details - value: *ref_54 + value: *ref_55 - summary: Buyer app requests for update of quote (tipping) api: update details: @@ -26277,7 +26299,7 @@ x-flows: reference: if any example: summary: Get quote for a specific product from a mobility catalog - value: &ref_90 + value: &ref_91 context: action: select bap_id: example-bap.com @@ -27429,7 +27451,7 @@ x-flows: reference: if any example: summary: Track an active ride - value: *ref_31 + value: *ref_32 - summary: Provider platform provides latest order tracking status api: on_track details: @@ -27449,7 +27471,7 @@ x-flows: reference: if any example: summary: Return tracking information for an order - value: *ref_32 + value: *ref_33 - summary: Ride provider provides latest order status api: on_status details: @@ -28244,7 +28266,7 @@ x-flows: reference: if any example: summary: Get latest fulfillment status of a booking - value: *ref_33 + value: *ref_34 - summary: Ride provider provides latest order status api: on_status details: @@ -29981,7 +30003,7 @@ x-flows: reference: if any example: summary: Track an active ride - value: &ref_58 + value: &ref_59 context: action: track bap_id: example-bap.com @@ -30020,7 +30042,7 @@ x-flows: reference: if any example: summary: Return tracking information for an order - value: &ref_59 + value: &ref_60 context: action: on_track bap_id: example-bap.com @@ -31107,7 +31129,7 @@ x-flows: reference: if any example: summary: Get latest fulfillment status of a booking - value: &ref_60 + value: &ref_61 context: action: status bap_id: example-bap.com @@ -32769,7 +32791,7 @@ x-flows: reference: if any example: summary: Track an active ride - value: *ref_58 + value: *ref_59 - summary: Provider platform provides latest order tracking status api: on_track details: @@ -32789,7 +32811,7 @@ x-flows: reference: if any example: summary: Return tracking information for an order - value: *ref_59 + value: *ref_60 - summary: Ride provider provides latest order status api: on_status details: @@ -33803,7 +33825,7 @@ x-flows: reference: if any example: summary: Get latest fulfillment status of a booking - value: *ref_60 + value: *ref_61 - summary: Ride provider provides latest order status api: on_status details: @@ -34470,7 +34492,7 @@ x-flows: reference: if any example: summary: Initiates cancelling a ride with soft cancel status - value: *ref_61 + value: *ref_62 - summary: Ride provider accepts/appends the terms of cancellation api: on_cancel details: @@ -34492,7 +34514,7 @@ x-flows: reference: if any example: summary: Return current order status after soft-cancel - value: &ref_72 + value: &ref_73 context: action: on_cancel bap_id: example-bap.com @@ -35024,7 +35046,7 @@ x-flows: reference: if any example: summary: Update an active ride - value: *ref_62 + value: *ref_63 - summary: Provider platform confirms with on_update request api: on_update details: @@ -35044,7 +35066,7 @@ x-flows: reference: if any example: summary: Return tracking information for an order - value: *ref_63 + value: *ref_64 - summary: Ride provider sends unsolicited on_status call api: on_status details: @@ -35346,7 +35368,7 @@ x-flows: summary: >- Initialize draft order and request for terms of service[Buyer Collecting] - value: &ref_69 + value: &ref_70 context: action: init bap_id: example-bap.com @@ -35425,7 +35447,7 @@ x-flows: reference: if any example: summary: Return draft order with payment terms[Buyer Collecting] - value: &ref_77 + value: &ref_78 context: action: on_init bap_id: example-bap.com @@ -35652,7 +35674,7 @@ x-flows: reference: if any example: summary: Get latest fulfillment status of a booking - value: &ref_91 + value: &ref_92 context: action: status bap_id: example-bap.com @@ -35688,7 +35710,7 @@ x-flows: reference: if any example: summary: Return draft order with payment terms[Buyer Collecting] - value: &ref_85 + value: &ref_86 context: action: on_status bap_id: example-bap.com @@ -35908,7 +35930,7 @@ x-flows: reference: if any example: summary: Confirm ride booking - value: &ref_68 + value: &ref_69 context: action: confirm bap_id: example-bap.com @@ -36000,7 +36022,7 @@ x-flows: reference: if any example: summary: Return confirmed order with latest fulfillment details - value: &ref_75 + value: &ref_76 context: action: on_confirm bap_id: example-bap.com @@ -37842,7 +37864,7 @@ x-flows: reference: if any example: summary: Track an active ride - value: *ref_31 + value: *ref_32 - summary: Provider platform provides latest order tracking status api: on_track details: @@ -37862,7 +37884,7 @@ x-flows: reference: if any example: summary: Return tracking information for an order - value: *ref_32 + value: *ref_33 - summary: Ride provider provides latest order status api: on_status details: @@ -38676,7 +38698,7 @@ x-flows: reference: if any example: summary: Get latest fulfillment status of a booking - value: *ref_33 + value: *ref_34 - summary: Ride provider provides latest order status api: on_status details: @@ -38993,10 +39015,10 @@ x-flows: reference: if any example: summary: Return confirmed order with latest fulfillment details - value: *ref_54 + value: *ref_55 - summary: Ride provider provides latest order status api: on_status - details: &ref_64 + details: &ref_65 - description: Ride provider provides the updated order status to the buyer app mermaid: |- sequenceDiagram @@ -39013,14 +39035,14 @@ x-flows: reference: if any example: summary: Return updated order with updated agent details - value: *ref_55 + value: *ref_56 - summary: Ride provider provides latest order status api: on_status - details: *ref_64 + details: *ref_65 reference: if any example: summary: Return updated order with updated agent details - value: *ref_65 + value: *ref_66 - summary: Buyer app cancels the request for ride api: cancel details: @@ -39040,7 +39062,7 @@ x-flows: reference: if any example: summary: Initiates cancelling a ride with soft cancel status - value: *ref_61 + value: *ref_62 - summary: Ride provider accepts/appends the terms of cancellation api: on_cancel details: @@ -39328,7 +39350,7 @@ x-flows: reference: if any example: summary: Initiates cancelling a ride with confirm cancel status - value: *ref_66 + value: *ref_67 - summary: Ride provider accepts the terms of cancellation api: on_cancel details: @@ -39995,7 +40017,7 @@ x-flows: reference: if any example: summary: Return confirmed order with latest fulfillment details - value: *ref_54 + value: *ref_55 - summary: Ride provider provides latest order status api: on_status details: @@ -40015,7 +40037,7 @@ x-flows: reference: if any example: summary: Return updated order with updated agent details - value: *ref_55 + value: *ref_56 - summary: Ride provider provides latest order status api: on_status details: @@ -40034,7 +40056,7 @@ x-flows: reference: if any example: summary: Return updated order with updated agent details - value: *ref_52 + value: *ref_53 - summary: Ride provider provides latest order updates api: on_status details: @@ -40052,7 +40074,7 @@ x-flows: reference: if any example: summary: Return updated order with updated agent details - value: *ref_53 + value: *ref_54 - summary: The Buyer App initiates the support request api: support details: @@ -40164,49 +40186,49 @@ x-examples: cancel: examples: - summary: Initiates_cancelling_a_ride_with_confirm_cancel_status___X5 - value: *ref_66 + value: *ref_67 - summary: Initiates_cancelling_a_ride_with_soft_cancel_status___X4 - value: *ref_61 + value: *ref_62 confirm: examples: - summary: Confirm_ride_booking___X6 - value: *ref_50 + value: *ref_51 - summary: >- confirm_buyer_app_confirms_the_booking_and_provides_all_the_required_information_for_confirmation_as_per_the_terms_of_the_order__5 description: TBD - value: *ref_67 + value: *ref_68 - summary: >- confirm_buyer_app_confirms_the_booking_and_provides_all_the_required_information_for_confirmation_as_per_the_terms_of_the_order__6 description: TBD - value: *ref_68 + value: *ref_69 init: examples: - summary: >- Initialize_draft_order_and_request_for_terms_of_service[Seller_Collecting]___X7 - value: *ref_48 + value: *ref_49 - summary: >- init_buyer_app_platform_shares_the_terms_of_order_and_initializes_the_request__1 description: TBD - value: *ref_69 + value: *ref_70 - summary: >- init_buyer_app_platform_shares_the_terms_of_order_and_initializes_the_request__3 description: TBD - value: *ref_70 + value: *ref_71 on_cancel: examples: - summary: Return_current_order_status_after_confirm-cancel___X9 - value: *ref_71 - - summary: Return_current_order_status_after_soft-cancel___X8 value: *ref_72 + - summary: Return_current_order_status_after_soft-cancel___X8 + value: *ref_73 - summary: cancel_after_confirm description: TBD - value: *ref_73 + value: *ref_74 on_confirm: examples: - summary: Return_confirmed_order_with_latest_fulfillment_details___X10 - value: *ref_54 + value: *ref_55 - summary: Return_confirmed_order_with_latest_fulfillment_details___X11 - value: *ref_57 + value: *ref_58 - summary: Return_confirmed_order_with_latest_fulfillment_details___X12 value: context: @@ -40459,26 +40481,26 @@ x-examples: - summary: >- on_confirm_ride_provider_confirms_the_ride_request_and_provides_the_ride_details_on_confirmation__6 description: TBD - value: *ref_74 + value: *ref_75 - summary: >- on_confirm_ride_provider_confirms_the_ride_request_and_provides_the_ride_details_on_confirmation__7 description: TBD - value: *ref_75 + value: *ref_76 - summary: ride_cancelled description: TBD - value: *ref_76 + value: *ref_77 on_init: examples: - summary: Return_draft_order_with_payment_terms[Seller_Collecting]___X13 - value: *ref_49 + value: *ref_50 - summary: >- on_init_ride_provider_accepts_the_terms_of_order_and_appends_its_own_terms_and_responds_with_the_final_draft__2 description: TBD - value: *ref_77 + value: *ref_78 - summary: >- on_init_ride_provider_accepts_the_terms_of_order_and_appends_its_own_terms_and_responds_with_the_final_draft__4 description: TBD - value: *ref_78 + value: *ref_79 on_rating: examples: - summary: Return_acknowledgement_of_rating_and_feedback___X14 @@ -40706,19 +40728,19 @@ x-examples: code: STATIC_TERMS value: https://example-test-bpp.com/static-terms.txt - summary: Return_a_mobility_catalog[Seller_Collecting]___X15 - value: *ref_45 + value: *ref_46 - summary: >- on_search_ride_providers_which_is_a_mobility_provider_platform_sends_the_catalog_of_all_services_that_can_be_used_for_transit_from_a_to_b_along_with_estimated_fare__1 description: TBD - value: *ref_79 + value: *ref_80 on_select: examples: - summary: Return_a_quote_offered_by_a_provider___X17 - value: *ref_47 + value: *ref_48 - summary: >- on_select_ride_provider_responds_with_detailed_information_and_quote_for_the_specific_service_that_the_buyer_app_would_like_to_avail__2 description: TBD - value: *ref_80 + value: *ref_81 on_status: examples: - summary: >- @@ -41417,39 +41439,39 @@ x-examples: value: '146' ttl: PT30S - summary: Return_order_with_status_-_Driver_at_pickup___X18 - value: *ref_81 + value: *ref_82 - summary: >- on_status_ride_provider_provides_the_latest_update_on_ride_details_to_the_buyer_app_with_fulfillment_state___ride_started_8 description: TBD - value: *ref_82 + value: *ref_83 - summary: >- on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_1 description: TBD - value: *ref_55 + value: *ref_56 - summary: >- on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_10 description: TBD - value: *ref_83 + value: *ref_84 - summary: >- on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_2 description: TBD - value: *ref_65 + value: *ref_66 - summary: >- on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_3 description: TBD - value: *ref_53 + value: *ref_54 - summary: >- on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_4 description: TBD - value: *ref_84 + value: *ref_85 - summary: >- on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_5 description: TBD - value: *ref_85 + value: *ref_86 - summary: >- on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_12 description: TBD - value: *ref_52 + value: *ref_53 on_support: examples: - summary: Return_support_information_related_to_an_order___X22 @@ -41479,13 +41501,13 @@ x-examples: on_track: examples: - summary: Return_tracking_information_for_an_order___X23 - value: *ref_32 + value: *ref_33 on_update: examples: - summary: Return_updated_order_with_recomputed_charges___X24 - value: *ref_86 - - summary: Return_updated_order_with_updated_agent_details___X26 value: *ref_87 + - summary: Return_updated_order_with_updated_agent_details___X26 + value: *ref_88 - summary: Return_updated_order_with_updated_billing_details___X25 value: context: @@ -41738,11 +41760,11 @@ x-examples: - summary: >- on_update_ride_provider_provides_the_latest_update_on_ride_details_to_the_buyer_app__7 description: TBD - value: *ref_88 + value: *ref_89 - summary: >- on_update_ride_provider_provides_the_updated_order_updates_to_the_buyer_app___can_update_the_quote_in_case_of_fare_update_9 description: TBD - value: *ref_89 + value: *ref_90 rating: examples: - summary: Provide_a_rating___X27 @@ -41861,19 +41883,19 @@ x-examples: collected_by: BPP - summary: >- Search_for_mobility_services_by_pickup_and_drop_location[Seller_Collecting]___X1 - value: *ref_30 + value: *ref_31 select: examples: - summary: Get_quote_for_a_specific_product_from_a_mobility_catalog___X3 - value: *ref_90 + value: *ref_91 status: examples: - summary: Get_latest_fulfillment_status_of_a_booking___X29 - value: *ref_33 + value: *ref_34 - summary: >- status_buyer_app_requests_the_ride_provider_to_provide_the_latest_order_status_4 description: TBD - value: *ref_91 + value: *ref_92 support: examples: - summary: Fetch_support_information_related_to_a_particular_order___X30 @@ -41901,15 +41923,15 @@ x-examples: track: examples: - summary: Track_an_active_ride___X31 - value: *ref_31 + value: *ref_32 x-attributes: on-demand: attribute_set: search: context: - location: &ref_92 + location: &ref_93 country: - code: &ref_160 + code: &ref_161 required: MANDATORY type: string owner: BAP @@ -41924,7 +41946,7 @@ x-attributes: This attribute defines the country of location where the transaction is meant to be completed. city: - code: &ref_161 + code: &ref_162 required: MANDATORY type: string owner: BAP @@ -41946,31 +41968,31 @@ x-attributes: description: >- This attribute defines the location where the transaction is meant to be completed. - domain: &ref_93 + domain: &ref_94 required: MANDATORY type: string owner: BAP usage: ONDC:TRV10 description: Describes domain code that is relevant to this transaction context - timestamp: &ref_94 + timestamp: &ref_95 required: MANDATORY type: string owner: BAP usage: 2023-03-23T04:41:16.000Z description: Describes tme of request generation in RFC3339 format - bap_id: &ref_95 + bap_id: &ref_96 required: MANDATORY type: string owner: BAP usage: api.example-bap.com description: Describes subscriber ID of the BAP - transaction_id: &ref_96 + transaction_id: &ref_97 required: MANDATORY type: string owner: BAP usage: 6743e9e2 description: Describes a unique value which persists across all API calls - message_id: &ref_97 + message_id: &ref_98 required: MANDATORY type: string owner: BAP @@ -41978,7 +42000,7 @@ x-attributes: description: >- Describes a unique value which persists during a request / callback cycle. - version: &ref_98 + version: &ref_99 required: MANDATORY type: integer owner: BAP @@ -41994,7 +42016,7 @@ x-attributes: description: >- Describes the Beckn protocol method being called by the sender and executed at the receiver. - bap_uri: &ref_99 + bap_uri: &ref_100 required: MANDATORY type: string owner: BAP @@ -42002,7 +42024,7 @@ x-attributes: description: >- Describes subscriber URL of the BAP for accepting callbacks from BPPs. - ttl: &ref_100 + ttl: &ref_101 required: MANDATORY type: string owner: BAP @@ -42030,7 +42052,7 @@ x-attributes: usage: FEMALE description: Describes the agent gender. stops: - type: &ref_101 + type: &ref_102 required: MANDATORY type: string owner: BAP @@ -42139,7 +42161,7 @@ x-attributes: owner: BAP usage: '--' description: The terms of settlement for this order - tags: &ref_123 + tags: &ref_124 BUYER_FINDER_FEES: required: MANDATORY type: OBJECT @@ -42233,13 +42255,13 @@ x-attributes: can align relevant options from available products or service. on_search: context: - location: *ref_92 - domain: *ref_93 - timestamp: *ref_94 - bap_id: *ref_95 - transaction_id: *ref_96 - message_id: *ref_97 - version: *ref_98 + location: *ref_93 + domain: *ref_94 + timestamp: *ref_95 + bap_id: *ref_96 + transaction_id: *ref_97 + message_id: *ref_98 + version: *ref_99 action: required: MANDATORY type: string @@ -42248,15 +42270,15 @@ x-attributes: description: >- Describes the Beckn protocol method being called by the sender and executed at the receiver. - bap_uri: *ref_99 - ttl: *ref_100 - bpp_id: &ref_102 + bap_uri: *ref_100 + ttl: *ref_101 + bpp_id: &ref_103 required: MANDATORY type: string owner: BPP usage: api.example-bpp.com description: Describes subscriber ID of the BPP - bpp_uri: &ref_103 + bpp_uri: &ref_104 required: MANDATORY type: string owner: BPP @@ -42279,13 +42301,13 @@ x-attributes: usage: '--' description: Describes the catalog's descriptor. providers: - id: &ref_105 + id: &ref_106 required: MANDATORY type: string owner: BPP usage: 450dec0f description: Describes the unique Id of the provider. - descriptor: &ref_113 + descriptor: &ref_114 name: required: OPTIONAL type: string @@ -42337,7 +42359,7 @@ x-attributes: usage: '--' description: Describes the provider's locations. fulfillments: - id: &ref_162 + id: &ref_163 required: MANDATORY type: string owner: BPP @@ -42371,7 +42393,7 @@ x-attributes: typically set when there are multiple ways an order can be fulfilled. stops: - type: *ref_101 + type: *ref_102 location: gps: required: MANDATORY @@ -42379,19 +42401,19 @@ x-attributes: owner: BAP usage: 28.707358, 77.180910 description: Describes the GPS co-ordinates of this location. - _description: &ref_116 + _description: &ref_117 required: MANDATORY type: object owner: BAP usage: '--' description: Describes the location of stops. - _description: &ref_117 + _description: &ref_118 required: MANDATORY type: object owner: BAP usage: '--' description: Describes the fulfillments stops. - vehicle: &ref_118 + vehicle: &ref_119 category: required: MANDATORY type: string @@ -42410,13 +42432,13 @@ x-attributes: owner: BPP usage: CAB description: Describes the vehicle energy type. - _description: &ref_203 + _description: &ref_204 required: MANDATORY type: object owner: BAP usage: '--' description: Describes the vehicle type. - _description: &ref_119 + _description: &ref_120 required: MANDATORY type: object owner: BAP/BPP @@ -42425,7 +42447,7 @@ x-attributes: Describes how a an order will be rendered/fulfilled to the end-customer items: - id: &ref_104 + id: &ref_105 required: MANDATORY type: string owner: BPP @@ -42444,26 +42466,26 @@ x-attributes: owner: BPP usage: RIDE description: Describes the name value of the item - _description: &ref_106 + _description: &ref_107 required: MANDATORY type: object owner: BPP usage: '--' description: Describes the items description. price: - currency: &ref_107 + currency: &ref_108 required: MANDATORY type: string owner: BPP usage: INR description: Describes the currency type of a product or service - value: &ref_108 + value: &ref_109 required: MANDATORY type: string owner: BPP usage: 60 description: Describes the price of a product or service - maximum_value: &ref_109 + maximum_value: &ref_110 required: OPTIONAL type: string owner: BPP @@ -42475,13 +42497,13 @@ x-attributes: owner: BPP usage: 50 description: Describes a minimum value price in decimal form - _description: &ref_110 + _description: &ref_111 required: MANDATORY type: object owner: BPP usage: '--' description: Describes the price of an item. - location_ids: &ref_126 + location_ids: &ref_127 required: OPTIONAL type: string owner: BPP @@ -42495,7 +42517,7 @@ x-attributes: owner: BPP usage: b68bb35b description: Describes the Unique reference ID for order fulfillment. - _description: &ref_111 + _description: &ref_112 required: MANDATORY type: object owner: BPP @@ -42507,7 +42529,7 @@ x-attributes: it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item. - tags: &ref_112 + tags: &ref_113 FARE_POLICY: required: MANDATORY type: OBJECT @@ -42680,7 +42702,7 @@ x-attributes: owner: BPP usage: '--' description: Denotes settlement amount - _description: &ref_114 + _description: &ref_115 required: MANDATORY type: object owner: BPP @@ -42694,13 +42716,13 @@ x-attributes: description: Describes the catalog's description. select: context: - location: *ref_92 - domain: *ref_93 - timestamp: *ref_94 - bap_id: *ref_95 - transaction_id: *ref_96 - message_id: *ref_97 - version: *ref_98 + location: *ref_93 + domain: *ref_94 + timestamp: *ref_95 + bap_id: *ref_96 + transaction_id: *ref_97 + message_id: *ref_98 + version: *ref_99 action: required: MANDATORY type: string @@ -42709,14 +42731,14 @@ x-attributes: description: >- Describes the Beckn protocol method being called by the sender and executed at the receiver. - bap_uri: *ref_99 - ttl: *ref_100 - bpp_id: *ref_102 - bpp_uri: *ref_103 + bap_uri: *ref_100 + ttl: *ref_101 + bpp_id: *ref_103 + bpp_uri: *ref_104 message: order: - items: &ref_120 - id: *ref_104 + items: &ref_121 + id: *ref_105 _description: required: MANDATORY type: object @@ -42727,8 +42749,8 @@ x-attributes: products or services selected and obtained within the specified order. provider: - id: *ref_105 - _description: &ref_121 + id: *ref_106 + _description: &ref_122 required: MANDATORY type: object owner: BPP @@ -42746,13 +42768,13 @@ x-attributes: created between the buyer and the seller. on_select: context: - location: *ref_92 - domain: *ref_93 - timestamp: *ref_94 - bap_id: *ref_95 - transaction_id: *ref_96 - message_id: *ref_97 - version: *ref_98 + location: *ref_93 + domain: *ref_94 + timestamp: *ref_95 + bap_id: *ref_96 + transaction_id: *ref_97 + message_id: *ref_98 + version: *ref_99 action: required: MANDATORY type: string @@ -42761,16 +42783,16 @@ x-attributes: description: >- Describes the Beckn protocol method being called by the sender and executed at the receiver. - bap_uri: *ref_99 - ttl: *ref_100 - bpp_id: *ref_102 - bpp_uri: *ref_103 + bap_uri: *ref_100 + ttl: *ref_101 + bpp_id: *ref_103 + bpp_uri: *ref_104 message: order: items: - id: *ref_104 - descriptor: &ref_124 - name: &ref_182 + id: *ref_105 + descriptor: &ref_125 + name: &ref_183 required: MANDATORY type: string owner: BPP @@ -42782,38 +42804,38 @@ x-attributes: owner: BPP usage: RIDE description: Describes the unique code value of the item - _description: *ref_106 + _description: *ref_107 price: - currency: *ref_107 - value: *ref_108 - maximum_value: *ref_109 - minimum_value: &ref_125 + currency: *ref_108 + value: *ref_109 + maximum_value: *ref_110 + minimum_value: &ref_126 required: OPTIONAL type: string owner: BPP usage: 50 description: Describes a minimum value of price in decimal form - _description: *ref_110 - location_ids: &ref_163 + _description: *ref_111 + location_ids: &ref_164 required: OPTIONAL type: string owner: BPP usage: d3ebf05b description: Provider Locations this item is available in - fulfillment_ids: &ref_115 + fulfillment_ids: &ref_116 required: MANDATORY type: string owner: BPP usage: b68bb35b description: Unique reference ID to the fulfillment of an order - _description: *ref_111 - tags: *ref_112 + _description: *ref_112 + tags: *ref_113 provider: - id: *ref_105 - descriptor: *ref_113 - _description: *ref_114 + id: *ref_106 + descriptor: *ref_114 + _description: *ref_115 fulfillments: - id: *ref_115 + id: *ref_116 type: required: OPTIONAL type: string @@ -42840,19 +42862,19 @@ x-attributes: usage: FEMALE description: Describes the agent gender. stops: - type: *ref_101 - location: &ref_128 + type: *ref_102 + location: &ref_129 gps: required: MANDATORY type: string owner: BAP usage: 28.686576, 77.441632 description: Describes the GPS co-ordinates of this location. - _description: *ref_116 - _description: *ref_117 - vehicle: *ref_118 - _description: *ref_119 - tags: &ref_129 + _description: *ref_117 + _description: *ref_118 + vehicle: *ref_119 + _description: *ref_120 + tags: &ref_130 ROUTE_INFO: required: MANDATORY type: OBJECT @@ -42873,35 +42895,35 @@ x-attributes: usage: '--' description: Describes the waypoints value. quote: - price: &ref_130 - value: *ref_108 + price: &ref_131 + value: *ref_109 currency: required: MANDATORY type: string owner: BPP usage: INR description: Describes the currency of a product or service - _description: &ref_176 + _description: &ref_177 required: MANDATORY type: object owner: BPP usage: '--' description: This refers to the value of used currency of quoted price. breakup: - title: &ref_131 + title: &ref_132 required: MANDATORY type: string owner: BPP usage: Base Fare description: Breakup title of the total quoted price price: - value: &ref_152 + value: &ref_153 required: MANDATORY type: string owner: BPP usage: INR description: Describes the price of a product or service - currency: &ref_153 + currency: &ref_154 required: MANDATORY type: string owner: BPP @@ -42909,13 +42931,13 @@ x-attributes: description: >- Describes the currency to be paid in of a product or service - _description: &ref_132 + _description: &ref_133 required: MANDATORY type: object owner: BPP usage: '--' description: Describes the breakup price - _description: &ref_133 + _description: &ref_134 required: MANDATORY type: object owner: BPP @@ -42923,13 +42945,13 @@ x-attributes: description: >- This attribute describes the breakup of the total quoted price. - ttl: &ref_134 + ttl: &ref_135 required: OPTIONAL type: string owner: BPP usage: P200s description: Time to live in seconds for an instance of this schema - _description: &ref_135 + _description: &ref_136 required: MANDATORY type: object owner: BPP @@ -42945,13 +42967,13 @@ x-attributes: description: Describes the order description. init: context: - location: *ref_92 - domain: *ref_93 - timestamp: *ref_94 - bap_id: *ref_95 - transaction_id: *ref_96 - message_id: *ref_97 - version: *ref_98 + location: *ref_93 + domain: *ref_94 + timestamp: *ref_95 + bap_id: *ref_96 + transaction_id: *ref_97 + message_id: *ref_98 + version: *ref_99 action: required: MANDATORY type: string @@ -42960,21 +42982,21 @@ x-attributes: description: >- Describes the Beckn protocol method being called by the sender and executed at the receiver. - bap_uri: *ref_99 - ttl: *ref_100 - bpp_id: *ref_102 - bpp_uri: *ref_103 + bap_uri: *ref_100 + ttl: *ref_101 + bpp_id: *ref_103 + bpp_uri: *ref_104 message: order: - items: *ref_120 + items: *ref_121 provider: - id: &ref_186 + id: &ref_187 required: MANDATORY type: string owner: BPP usage: 450dec0f description: Id of the provider - _description: *ref_121 + _description: *ref_122 billing: name: required: MANDATORY @@ -42982,38 +43004,38 @@ x-attributes: owner: BAP usage: John Doe description: Name of the billable entity - _description: &ref_140 + _description: &ref_141 required: MANDATORY type: object owner: BAP usage: '--' description: The billing details of this order fulfillments: - id: *ref_115 + id: *ref_116 customer: person: - name: &ref_168 + name: &ref_169 required: MANDATORY type: string owner: BAP usage: Jason Roy description: Name of the customer - _description: &ref_122 + _description: &ref_123 required: MANDATORY type: object owner: BAP usage: '--' description: Describes contact of end-customer contact: - phone: &ref_170 + phone: &ref_171 required: MANDATORY type: string owner: BAP usage: 9898657512 description: Contact number of the customer - _description: *ref_122 + _description: *ref_123 stops: - type: &ref_127 + type: &ref_128 required: MANDATORY type: string owner: BAP @@ -43021,17 +43043,17 @@ x-attributes: description: >- The type of stop. Allowed values of this property can be defined by the network policy. - location: &ref_151 + location: &ref_152 gps: required: MANDATORY type: string owner: BAP usage: 28.707358, 77.180910 description: The GPS co-ordinates of this location. - _description: *ref_116 - _description: *ref_117 - vehicle: &ref_146 - category: &ref_202 + _description: *ref_117 + _description: *ref_118 + vehicle: &ref_147 + category: &ref_203 required: OPTIONAL type: string owner: BAP @@ -43049,9 +43071,9 @@ x-attributes: owner: BAP usage: '--' description: Describes the vehicle type. - _description: *ref_119 + _description: *ref_120 payments: - collected_by: &ref_136 + collected_by: &ref_137 required: MANDATORY type: string owner: BAP @@ -43088,20 +43110,20 @@ x-attributes: owner: BAP usage: 9988199772@okicic description: Virtual payment address associated with payment activity - _description: &ref_137 + _description: &ref_138 required: MANDATORY type: object owner: BAP usage: '--' description: This attribute defines the payment params for this order. - _description: &ref_138 + _description: &ref_139 required: MANDATORY type: object owner: BAP/BPP usage: '--' description: The terms of settlement for this order - tags: *ref_123 - _description: &ref_147 + tags: *ref_124 + _description: &ref_148 required: MANDATORY type: object owner: BAP/BPP @@ -43111,13 +43133,13 @@ x-attributes: created between the buyer and the seller. on_init: context: - location: *ref_92 - domain: *ref_93 - timestamp: *ref_94 - bap_id: *ref_95 - transaction_id: *ref_96 - message_id: *ref_97 - version: *ref_98 + location: *ref_93 + domain: *ref_94 + timestamp: *ref_95 + bap_id: *ref_96 + transaction_id: *ref_97 + message_id: *ref_98 + version: *ref_99 action: required: MANDATORY type: string @@ -43126,10 +43148,10 @@ x-attributes: description: >- Describes the Beckn protocol method being called by the sender and executed at the receiver. - bap_uri: *ref_99 - ttl: *ref_100 - bpp_id: *ref_102 - bpp_uri: *ref_103 + bap_uri: *ref_100 + ttl: *ref_101 + bpp_id: *ref_103 + bpp_uri: *ref_104 message: order: items: @@ -43139,7 +43161,7 @@ x-attributes: owner: BPP usage: ecf4d145-4ea3-45fe-ab3d-7bcf6b9f456b description: Describes the unique Id of the item. - descriptor: *ref_124 + descriptor: *ref_125 price: currency: required: MANDATORY @@ -43147,20 +43169,20 @@ x-attributes: owner: BPP usage: INR description: Describes the price of selected item. - value: *ref_108 - maximum_value: *ref_109 - minimum_value: *ref_125 - _description: *ref_110 - location_ids: *ref_126 - fulfillment_ids: *ref_115 - payment_ids: &ref_185 + value: *ref_109 + maximum_value: *ref_110 + minimum_value: *ref_126 + _description: *ref_111 + location_ids: *ref_127 + fulfillment_ids: *ref_116 + payment_ids: &ref_186 required: MANDATORY type: string owner: BPP usage: bc08edb1 description: Unique reference ID to the payment of an order - _description: *ref_111 - tags: *ref_112 + _description: *ref_112 + tags: *ref_113 provider: id: required: MANDATORY @@ -43168,10 +43190,10 @@ x-attributes: owner: BPP usage: 450dec0f description: Describes the unqiue Id of the provider - descriptor: *ref_113 - _description: *ref_114 + descriptor: *ref_114 + _description: *ref_115 fulfillments: - id: *ref_115 + id: *ref_116 type: required: MANDATORY type: string @@ -43179,12 +43201,12 @@ x-attributes: usage: DELIVERY description: A code that describes the mode of fulfillment. stops: - type: *ref_127 - location: *ref_128 - _description: *ref_117 - vehicle: *ref_118 - _description: *ref_119 - customer: &ref_150 + type: *ref_128 + location: *ref_129 + _description: *ref_118 + vehicle: *ref_119 + _description: *ref_120 + customer: &ref_151 person: name: required: MANDATORY @@ -43198,7 +43220,7 @@ x-attributes: owner: BAP usage: FEMALE description: Describes the agent gender. - _description: &ref_169 + _description: &ref_170 required: MANDATORY type: object owner: BAP @@ -43211,13 +43233,13 @@ x-attributes: owner: BAP usage: 9898657512 description: Describes the contact number of the customer - _description: &ref_171 + _description: &ref_172 required: MANDATORY type: object owner: BAP usage: '--' description: Describes the customer contact details. - _description: &ref_172 + _description: &ref_173 required: MANDATORY type: object owner: BAP @@ -43231,11 +43253,11 @@ x-attributes: owner: BAP usage: FEMALE description: Describes the agent gender - tags: *ref_129 + tags: *ref_130 quote: - price: *ref_130 + price: *ref_131 breakup: - title: *ref_131 + title: *ref_132 price: currency: required: MANDATORY @@ -43251,12 +43273,12 @@ x-attributes: owner: BPP usage: 120 description: Describes the price of a product or service - _description: *ref_132 - _description: *ref_133 - ttl: *ref_134 - _description: *ref_135 + _description: *ref_133 + _description: *ref_134 + ttl: *ref_135 + _description: *ref_136 payments: - id: &ref_154 + id: &ref_155 required: MANDATORY type: string owner: BPP @@ -43264,41 +43286,41 @@ x-attributes: description: >- Describes the ID of the payment term that can be referred at an item or an order level in a catalog - collected_by: *ref_136 - status: &ref_141 + collected_by: *ref_137 + status: &ref_142 required: MANDATORY type: string owner: BAP usage: NOT-PAID description: Describe the payment Status for particular order - type: &ref_142 + type: &ref_143 required: MANDATORY type: string owner: BAP usage: PRE_ORDER description: Describe the payment type for particular order params: - bank_code: &ref_143 + bank_code: &ref_144 required: MANDATORY type: string owner: BPP usage: XXXXXXXX description: Bank code associated with payment activity - bank_account_number: &ref_144 + bank_account_number: &ref_145 required: MANDATORY type: string owner: BPP usage: xxxxxxxxxxxxxx description: Bank account number associated with payment activity - virtual_payment_address: &ref_145 + virtual_payment_address: &ref_146 required: MANDATORY type: string owner: BPP usage: 9988199772@okicic description: Virtual payment address associated with payment activity - _description: *ref_137 - _description: *ref_138 - tags: *ref_123 + _description: *ref_138 + _description: *ref_139 + tags: *ref_124 cancellation_terms: fulfillment_state: descriptor: @@ -43308,19 +43330,19 @@ x-attributes: owner: BPP usage: RIDE_ENROUTE_PICKUP description: Describes the unique code for the cancellation terms - _description: &ref_139 + _description: &ref_140 required: MANDATORY type: object owner: BPP usage: '--' description: Describes the price of a product or service - reason_required: &ref_156 + reason_required: &ref_157 required: MANDATORY type: string owner: BPP usage: true description: Indicates whether a reason is required to cancel the order - cancellation_fee: &ref_157 + cancellation_fee: &ref_158 percentage: required: OPTIONAL type: string @@ -43340,20 +43362,20 @@ x-attributes: owner: BPP usage: 30 description: Describes the price of a product or service - _description: *ref_139 - _description: &ref_158 + _description: *ref_140 + _description: &ref_159 required: MANDATORY type: object owner: BPP usage: '--' description: Describes the unique code for the cancellation terms - _description: &ref_159 + _description: &ref_160 required: MANDATORY type: object owner: BAP/BPP usage: '--' description: Describes the order description. - id: &ref_148 + id: &ref_149 required: OPTIONAL type: string owner: BPP @@ -43361,13 +43383,13 @@ x-attributes: description: Describes the unqiue order ID. confirm: context: - location: *ref_92 - domain: *ref_93 - timestamp: *ref_94 - bap_id: *ref_95 - transaction_id: *ref_96 - message_id: *ref_97 - version: *ref_98 + location: *ref_93 + domain: *ref_94 + timestamp: *ref_95 + bap_id: *ref_96 + transaction_id: *ref_97 + message_id: *ref_98 + version: *ref_99 action: required: MANDATORY type: string @@ -43376,14 +43398,14 @@ x-attributes: description: >- Describes the Beckn protocol method being called by the sender and executed at the receiver. - bap_uri: *ref_99 - ttl: *ref_100 - bpp_id: *ref_102 - bpp_uri: *ref_103 + bap_uri: *ref_100 + ttl: *ref_101 + bpp_id: *ref_103 + bpp_uri: *ref_104 message: order: items: - id: *ref_104 + id: *ref_105 _description: required: MANDATORY type: object @@ -43393,7 +43415,7 @@ x-attributes: This decription refers to the comprehensive list of the products or services selected and obtained within the specified order. - tags: *ref_112 + tags: *ref_113 provider: id: required: MANDATORY @@ -43401,7 +43423,7 @@ x-attributes: owner: BPP usage: 450dec0f description: Describes the uique Id of the provider. - _description: *ref_121 + _description: *ref_122 billing: name: required: MANDATORY @@ -43409,7 +43431,7 @@ x-attributes: owner: BAP usage: John Doe description: Describes the Name of the billable entity - _description: *ref_140 + _description: *ref_141 payments: id: required: MANDATORY @@ -43419,24 +43441,24 @@ x-attributes: description: >- ID of the payment term that can be referred at an item or an order level in a catalog - collected_by: *ref_136 - status: *ref_141 - type: *ref_142 + collected_by: *ref_137 + status: *ref_142 + type: *ref_143 params: - bank_code: *ref_143 - bank_account_number: *ref_144 - virtual_payment_address: *ref_145 - transaction_id: &ref_155 + bank_code: *ref_144 + bank_account_number: *ref_145 + virtual_payment_address: *ref_146 + transaction_id: &ref_156 required: OPTIONAL type: string owner: BPP usage: cda41144 description: Describes transaction ID associated with payment activity - _description: *ref_137 - _description: *ref_138 - tags: *ref_123 + _description: *ref_138 + _description: *ref_139 + tags: *ref_124 fulfillments: - id: *ref_115 + id: *ref_116 customer: person: name: @@ -43445,7 +43467,7 @@ x-attributes: owner: BAP usage: Jason Roy description: Describe the name of the customer - _description: *ref_122 + _description: *ref_123 contact: phone: required: MANDATORY @@ -43453,9 +43475,9 @@ x-attributes: owner: BAP usage: 9898657512 description: Describe the contact number of the customer - _description: *ref_122 + _description: *ref_123 stops: - type: *ref_101 + type: *ref_102 location: gps: required: MANDATORY @@ -43463,22 +43485,22 @@ x-attributes: owner: BAP usage: 28.686576, 77.441632 description: The GPS co-ordinates of this location. - _description: *ref_116 - _description: *ref_117 - vehicle: *ref_146 - _description: *ref_119 - tags: *ref_129 - _description: *ref_147 - id: *ref_148 + _description: *ref_117 + _description: *ref_118 + vehicle: *ref_147 + _description: *ref_120 + tags: *ref_130 + _description: *ref_148 + id: *ref_149 on_confirm: context: - location: *ref_92 - domain: *ref_93 - timestamp: *ref_94 - bap_id: *ref_95 - transaction_id: *ref_96 - message_id: *ref_97 - version: *ref_98 + location: *ref_93 + domain: *ref_94 + timestamp: *ref_95 + bap_id: *ref_96 + transaction_id: *ref_97 + message_id: *ref_98 + version: *ref_99 action: required: MANDATORY type: string @@ -43487,14 +43509,14 @@ x-attributes: description: >- Describes the Beckn protocol method being called by the sender and executed at the receiver. - bap_uri: *ref_99 - ttl: *ref_100 - bpp_id: *ref_102 - bpp_uri: *ref_103 + bap_uri: *ref_100 + ttl: *ref_101 + bpp_id: *ref_103 + bpp_uri: *ref_104 message: order: items: - id: *ref_104 + id: *ref_105 descriptor: name: required: MANDATORY @@ -43508,8 +43530,8 @@ x-attributes: owner: BPP usage: SJT description: Describes the unique code value of the item - _description: *ref_106 - price: &ref_164 + _description: *ref_107 + price: &ref_165 currency: required: MANDATORY type: string @@ -43518,30 +43540,30 @@ x-attributes: description: >- Describes the currency type to be paid in of a product or service - value: *ref_108 - maximum_value: &ref_183 + value: *ref_109 + maximum_value: &ref_184 required: OPTIONAL type: string owner: BPP usage: 176 description: Describes a maximum value in decimal form - minimum_value: &ref_184 + minimum_value: &ref_185 required: OPTIONAL type: string owner: BPP usage: 50 description: Describes a minimum value in decimal form - _description: *ref_110 - location_ids: *ref_126 - fulfillment_ids: *ref_115 - payment_ids: &ref_149 + _description: *ref_111 + location_ids: *ref_127 + fulfillment_ids: *ref_116 + payment_ids: &ref_150 required: MANDATORY type: string owner: BPP usage: P1 description: Unique reference ID to the payment of an order - _description: *ref_111 - tags: *ref_112 + _description: *ref_112 + tags: *ref_113 provider: id: required: MANDATORY @@ -43549,12 +43571,12 @@ x-attributes: owner: BPP usage: 450dec0f description: Unique reference ID to the payment of an order - descriptor: *ref_113 - _description: *ref_114 + descriptor: *ref_114 + _description: *ref_115 fulfillments: - id: *ref_115 - type: *ref_149 - customer: *ref_150 + id: *ref_116 + type: *ref_150 + customer: *ref_151 agent: person: name: @@ -43621,7 +43643,7 @@ x-attributes: owner: BPP usage: RIDE_ASSIGNED description: Describes the state's code for fulfillment. - _description: &ref_175 + _description: &ref_176 required: MANDATORY type: object owner: BPP @@ -43636,9 +43658,9 @@ x-attributes: description: >- The type of stop. Allowed values of this property can be defined by the network policy. - location: *ref_151 - authorization: &ref_201 - type: &ref_165 + location: *ref_152 + authorization: &ref_202 + type: &ref_166 required: OPTIONAL type: string owner: BPP @@ -43647,7 +43669,7 @@ x-attributes: Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy. - token: &ref_166 + token: &ref_167 required: OPTIONAL type: string owner: BPP @@ -43663,26 +43685,26 @@ x-attributes: owner: BPP usage: '--' description: Describes the authorization for a fulfillments stop. - _description: &ref_167 + _description: &ref_168 required: MANDATORY type: object owner: BAP/BPP usage: '--' description: Describes the fulfillments stops. vehicle: - category: &ref_173 + category: &ref_174 required: MANDATORY type: string owner: BAP usage: AUTO_RICKSHAW description: Describes vehicle category - make: &ref_187 + make: &ref_188 required: OPTIONAL type: string owner: BPP usage: Bajaj description: Describes vehicle manufacturer - model: &ref_188 + model: &ref_189 required: OPTIONAL type: string owner: BPP @@ -43700,51 +43722,51 @@ x-attributes: owner: BAP usage: CAB description: Describes the vehicle variant. - _description: &ref_174 + _description: &ref_175 required: MANDATORY type: object owner: BAP/BPP usage: '--' description: Describes the vehicle type. - _description: *ref_119 - tags: *ref_129 - quote: &ref_192 - price: *ref_130 + _description: *ref_120 + tags: *ref_130 + quote: &ref_193 + price: *ref_131 breakup: - title: *ref_131 + title: *ref_132 price: - currency: *ref_152 - value: *ref_153 - _description: *ref_132 - _description: *ref_133 - ttl: *ref_134 - _description: *ref_135 + currency: *ref_153 + value: *ref_154 + _description: *ref_133 + _description: *ref_134 + ttl: *ref_135 + _description: *ref_136 payments: - id: *ref_154 - collected_by: *ref_136 - status: &ref_178 + id: *ref_155 + collected_by: *ref_137 + status: &ref_179 required: MANDATORY type: string owner: BAP usage: NOT-PAID description: Describe the Payment Status - type: &ref_177 + type: &ref_178 required: MANDATORY type: string owner: BAP usage: PRE_ORDER description: Describe the Payment type params: - bank_code: *ref_143 - bank_account_number: *ref_144 - virtual_payment_address: *ref_145 - amount: &ref_193 + bank_code: *ref_144 + bank_account_number: *ref_145 + virtual_payment_address: *ref_146 + amount: &ref_194 required: OPTIONAL type: string owner: BPP usage: 146 description: Describes the amount associated with the payment transaction - currency: &ref_194 + currency: &ref_195 required: OPTIONAL type: string owner: BPP @@ -43752,9 +43774,9 @@ x-attributes: description: >- Describes the currency associated with the payment transaction - transaction_id: *ref_155 - tags: *ref_123 - cancellation_terms: &ref_179 + transaction_id: *ref_156 + tags: *ref_124 + cancellation_terms: &ref_180 fulfillment_state: descriptor: code: @@ -43763,48 +43785,48 @@ x-attributes: owner: BPP usage: RIDE_ENROUTE_PICKUP description: Describes the unique code for the cancellation terms. - _description: *ref_139 - reason_required: *ref_156 - cancellation_fee: *ref_157 - _description: *ref_158 + _description: *ref_140 + reason_required: *ref_157 + cancellation_fee: *ref_158 + _description: *ref_159 status: required: MANDATORY type: string owner: BPP usage: ACTIVE description: Describes the order status. - created_at: &ref_209 + created_at: &ref_210 required: MANDATORY type: string owner: BPP usage: 2023-12-10T08:03:34.294Z description: Describes the date-time of creation of this order - updated_at: &ref_210 + updated_at: &ref_211 required: MANDATORY type: string owner: BPP usage: 2023-12-10T08:03:34.294Z description: Describes The date-time of updated of this order - id: &ref_180 + id: &ref_181 required: MANDATORY type: string owner: BPP usage: ec08edb2 description: Describes the unqiue order ID. - _description: *ref_159 + _description: *ref_160 cancel: context: - location: &ref_181 + location: &ref_182 country: - code: *ref_160 - city: code: *ref_161 - domain: *ref_93 - timestamp: *ref_94 - bap_id: *ref_95 - transaction_id: *ref_96 - message_id: *ref_97 - version: *ref_98 + city: + code: *ref_162 + domain: *ref_94 + timestamp: *ref_95 + bap_id: *ref_96 + transaction_id: *ref_97 + message_id: *ref_98 + version: *ref_99 action: required: MANDATORY type: string @@ -43813,10 +43835,10 @@ x-attributes: description: >- Describes the Beckn protocol method being called by the sender and executed at the receiver. - bap_uri: *ref_99 - ttl: *ref_100 - bpp_id: *ref_102 - bpp_uri: *ref_103 + bap_uri: *ref_100 + ttl: *ref_101 + bpp_id: *ref_103 + bpp_uri: *ref_104 message: order_id: required: MANDATORY @@ -43860,13 +43882,13 @@ x-attributes: been offered to the end customer. on_cancel: context: - location: *ref_92 - domain: *ref_93 - timestamp: *ref_94 - bap_id: *ref_95 - transaction_id: *ref_96 - message_id: *ref_97 - version: *ref_98 + location: *ref_93 + domain: *ref_94 + timestamp: *ref_95 + bap_id: *ref_96 + transaction_id: *ref_97 + message_id: *ref_98 + version: *ref_99 action: required: MANDATORY type: string @@ -43875,10 +43897,10 @@ x-attributes: description: >- Describes the Beckn protocol method being called by the sender and executed at the receiver. - bap_uri: *ref_99 - ttl: *ref_100 - bpp_id: *ref_102 - bpp_uri: *ref_103 + bap_uri: *ref_100 + ttl: *ref_101 + bpp_id: *ref_103 + bpp_uri: *ref_104 message: order: items: @@ -43888,18 +43910,18 @@ x-attributes: owner: BPP usage: ecf4d145 description: 'Describes the unique ID of the order. ' - descriptor: *ref_124 - fulfillment_ids: *ref_162 + descriptor: *ref_125 + fulfillment_ids: *ref_163 payment_ids: required: MANDATORY type: string owner: BPP usage: bc08edb1 description: Describes the unique reference ID to the payment of an order - location_ids: *ref_163 - price: *ref_164 - _description: *ref_111 - tags: *ref_112 + location_ids: *ref_164 + price: *ref_165 + _description: *ref_112 + tags: *ref_113 provider: id: required: MANDATORY @@ -43907,23 +43929,23 @@ x-attributes: owner: BPP usage: 450dec0f description: Describes the unique ID of the provider. - descriptor: *ref_113 - _description: *ref_114 + descriptor: *ref_114 + _description: *ref_115 fulfillments: - id: *ref_115 + id: *ref_116 stops: - type: *ref_127 + type: *ref_128 location: - gps: &ref_200 + gps: &ref_201 required: MANDATORY type: string owner: BAP usage: 28.686576, 77.441632 description: Describes a GPS coordinate - _description: *ref_116 + _description: *ref_117 authorization: - type: *ref_165 - token: *ref_166 + type: *ref_166 + token: *ref_167 time: duration: required: OPTIONAL @@ -43931,16 +43953,16 @@ x-attributes: owner: BPP usage: PT2H description: Describes the duration. - _description: *ref_167 + _description: *ref_168 customer: person: - name: *ref_168 - _description: *ref_169 - contact: &ref_204 - phone: *ref_170 - _description: *ref_171 - _description: *ref_172 - agent: &ref_190 + name: *ref_169 + _description: *ref_170 + contact: &ref_205 + phone: *ref_171 + _description: *ref_172 + _description: *ref_173 + agent: &ref_191 person: name: required: OPTIONAL @@ -43999,13 +44021,13 @@ x-attributes: usage: '--' description: Describes the agent. vehicle: - registration: &ref_189 + registration: &ref_190 required: MANDATORY type: string owner: BPP usage: HR-20AS-4578 description: Describes vehicle registration details - category: *ref_173 + category: *ref_174 make: required: MANDATORY type: string @@ -44024,8 +44046,8 @@ x-attributes: owner: BAP usage: CAB description: Describes the vehicle variant. - _description: *ref_174 - state: &ref_191 + _description: *ref_175 + state: &ref_192 descriptor: code: required: MANDATORY @@ -44039,15 +44061,15 @@ x-attributes: owner: BPP usage: Driver is on the way description: Describes the current state - _description: *ref_175 - type: *ref_149 - _description: *ref_119 - tags: *ref_129 + _description: *ref_176 + type: *ref_150 + _description: *ref_120 + tags: *ref_130 quote: price: - value: *ref_108 - currency: *ref_107 - _description: *ref_176 + value: *ref_109 + currency: *ref_108 + _description: *ref_177 breakup: title: required: MANDATORY @@ -44056,17 +44078,17 @@ x-attributes: usage: Base Fare description: Describes the Breakup title of the total quoted price price: - currency: *ref_152 + currency: *ref_153 value: required: MANDATORY type: string owner: BPP usage: 120 description: Describes the currency type of a product or service - _description: *ref_132 - _description: *ref_133 - ttl: *ref_134 - _description: *ref_135 + _description: *ref_133 + _description: *ref_134 + ttl: *ref_135 + _description: *ref_136 payments: id: required: MANDATORY @@ -44076,7 +44098,7 @@ x-attributes: description: >- ID of the payment term that can be referred at an item or an order level in a catalog - type: *ref_177 + type: *ref_178 params: currency: required: OPTIONAL @@ -44090,8 +44112,8 @@ x-attributes: owner: BPP usage: 60 description: Describes a numerical value in decimal form - bank_code: *ref_143 - bank_account_number: *ref_144 + bank_code: *ref_144 + bank_account_number: *ref_145 bank_account_name: required: OPTIONAL type: string @@ -44111,19 +44133,19 @@ x-attributes: owner: BPP usage: P1D description: Describes time transaction duration - collected_by: *ref_136 - status: *ref_178 - tags: *ref_123 - cancellation_terms: *ref_179 - id: *ref_180 + collected_by: *ref_137 + status: *ref_179 + tags: *ref_124 + cancellation_terms: *ref_180 + id: *ref_181 status: required: MANDATORY type: string owner: BPP usage: SOFT_CANCEL description: Describes the order status. - _description: *ref_159 - documents: &ref_195 + _description: *ref_160 + documents: &ref_196 descriptor: code: required: OPTIONAL @@ -44183,13 +44205,13 @@ x-attributes: type: object status: context: - location: *ref_181 - domain: *ref_93 - timestamp: *ref_94 - bap_id: *ref_95 - transaction_id: *ref_96 - message_id: *ref_97 - version: *ref_98 + location: *ref_182 + domain: *ref_94 + timestamp: *ref_95 + bap_id: *ref_96 + transaction_id: *ref_97 + message_id: *ref_98 + version: *ref_99 action: required: MANDATORY type: string @@ -44198,10 +44220,10 @@ x-attributes: description: >- Describes the Beckn protocol method being called by the sender and executed at the receiver. - bap_uri: *ref_99 - ttl: *ref_100 - bpp_id: *ref_102 - bpp_uri: *ref_103 + bap_uri: *ref_100 + ttl: *ref_101 + bpp_id: *ref_103 + bpp_uri: *ref_104 message: order_id: required: OPTIONAL @@ -44219,14 +44241,14 @@ x-attributes: transaction ID. on_status: context: - location: *ref_92 - domain: *ref_93 - timestamp: *ref_94 - bap_id: *ref_95 - transaction_id: *ref_96 - message_id: *ref_97 - version: *ref_98 - action: &ref_196 + location: *ref_93 + domain: *ref_94 + timestamp: *ref_95 + bap_id: *ref_96 + transaction_id: *ref_97 + message_id: *ref_98 + version: *ref_99 + action: &ref_197 required: MANDATORY type: string owner: BAP @@ -44234,50 +44256,50 @@ x-attributes: description: >- Describes the Beckn protocol method being called by the sender and executed at the receiver. - bap_uri: *ref_99 - ttl: *ref_100 - bpp_id: *ref_102 - bpp_uri: *ref_103 + bap_uri: *ref_100 + ttl: *ref_101 + bpp_id: *ref_103 + bpp_uri: *ref_104 message: order: items: - id: &ref_197 + id: &ref_198 required: MANDATORY type: string owner: BPP usage: ecf4d145 description: 'Describes the unique ID of the item. ' descriptor: - name: *ref_182 + name: *ref_183 code: required: MANDATORY type: string owner: BPP usage: RIDE description: Describes the item code. - _description: *ref_106 - price: &ref_198 - currency: *ref_107 + _description: *ref_107 + price: &ref_199 + currency: *ref_108 value: required: MANDATORY type: string owner: BPP usage: 60 description: Describes a numerical value in decimal form - maximum_value: *ref_183 - minimum_value: *ref_184 - _description: *ref_110 - location_ids: *ref_163 - fulfillment_ids: *ref_115 - payment_ids: *ref_185 - _description: *ref_111 - tags: *ref_112 - provider: &ref_199 - id: *ref_186 - descriptor: *ref_113 - _description: *ref_114 + maximum_value: *ref_184 + minimum_value: *ref_185 + _description: *ref_111 + location_ids: *ref_164 + fulfillment_ids: *ref_116 + payment_ids: *ref_186 + _description: *ref_112 + tags: *ref_113 + provider: &ref_200 + id: *ref_187 + descriptor: *ref_114 + _description: *ref_115 fulfillments: - id: *ref_115 + id: *ref_116 stops: type: required: MANDATORY @@ -44294,8 +44316,8 @@ x-attributes: owner: BPP usage: 28.686576, 77.441632 description: Describes a GPS coordinate - _description: *ref_116 - _description: *ref_167 + _description: *ref_117 + _description: *ref_168 vehicle: category: required: MANDATORY @@ -44303,10 +44325,10 @@ x-attributes: owner: BPP usage: CAB description: Describes vehicle category - make: *ref_187 - model: *ref_188 - registration: *ref_189 - _description: *ref_174 + make: *ref_188 + model: *ref_189 + registration: *ref_190 + _description: *ref_175 variant: required: MANDATORY type: string @@ -44321,7 +44343,7 @@ x-attributes: owner: BPP usage: Jason Roy description: Name of the customer - _description: *ref_169 + _description: *ref_170 contact: phone: required: MANDATORY @@ -44329,21 +44351,21 @@ x-attributes: owner: BPP usage: 9898657512 description: Contact number of the customer - _description: *ref_171 - _description: *ref_172 - agent: *ref_190 - type: &ref_205 + _description: *ref_172 + _description: *ref_173 + agent: *ref_191 + type: &ref_206 required: MANDATORY type: string owner: BPP usage: Delivery description: Describes type of fullfilment - state: *ref_191 - _description: *ref_119 - tags: *ref_129 - quote: *ref_192 + state: *ref_192 + _description: *ref_120 + tags: *ref_130 + quote: *ref_193 payments: - id: &ref_206 + id: &ref_207 required: MANDATORY type: string owner: BPP @@ -44351,28 +44373,28 @@ x-attributes: description: >- ID of the payment term that can be referred at an item or an order level in a catalog - collected_by: *ref_136 - status: &ref_207 + collected_by: *ref_137 + status: &ref_208 required: MANDATORY type: string owner: BAP usage: NOT-PAID description: Payment Status - type: &ref_208 + type: &ref_209 required: MANDATORY type: string owner: BAP usage: PRE_ORDER description: Payment type params: - bank_code: *ref_143 - bank_account_number: *ref_144 - virtual_payment_address: *ref_145 - transaction_id: *ref_155 - amount: *ref_193 - currency: *ref_194 - tags: *ref_123 - cancellation_terms: *ref_179 + bank_code: *ref_144 + bank_account_number: *ref_145 + virtual_payment_address: *ref_146 + transaction_id: *ref_156 + amount: *ref_194 + currency: *ref_195 + tags: *ref_124 + cancellation_terms: *ref_180 status: required: OPTIONAL type: string @@ -44391,23 +44413,23 @@ x-attributes: owner: BPP usage: 2023-12-10T08:03:34.294Z description: Describes The date-time of updated of this order - id: *ref_148 - _description: *ref_159 - documents: *ref_195 + id: *ref_149 + _description: *ref_160 + documents: *ref_196 update: context: - location: *ref_181 - domain: *ref_93 - timestamp: *ref_94 - bap_id: *ref_95 - transaction_id: *ref_96 - message_id: *ref_97 - version: *ref_98 - action: *ref_196 - bap_uri: *ref_99 - ttl: *ref_100 - bpp_id: *ref_102 - bpp_uri: *ref_103 + location: *ref_182 + domain: *ref_94 + timestamp: *ref_95 + bap_id: *ref_96 + transaction_id: *ref_97 + message_id: *ref_98 + version: *ref_99 + action: *ref_197 + bap_uri: *ref_100 + ttl: *ref_101 + bpp_id: *ref_103 + bpp_uri: *ref_104 message: order: id: @@ -44439,13 +44461,13 @@ x-attributes: description: Describes the unique order id on_update: context: - location: *ref_92 - domain: *ref_93 - timestamp: *ref_94 - bap_id: *ref_95 - transaction_id: *ref_96 - message_id: *ref_97 - version: *ref_98 + location: *ref_93 + domain: *ref_94 + timestamp: *ref_95 + bap_id: *ref_96 + transaction_id: *ref_97 + message_id: *ref_98 + version: *ref_99 action: required: MANDATORY type: string @@ -44454,14 +44476,14 @@ x-attributes: description: >- Describes the Beckn protocol method being called by the sender and executed at the receiver. - bap_uri: *ref_99 - ttl: *ref_100 - bpp_id: *ref_102 - bpp_uri: *ref_103 + bap_uri: *ref_100 + ttl: *ref_101 + bpp_id: *ref_103 + bpp_uri: *ref_104 message: order: items: - id: *ref_197 + id: *ref_198 descriptor: name: required: MANDATORY @@ -44475,34 +44497,34 @@ x-attributes: owner: BPP usage: RIDE description: 'Describes the item code. ' - _description: *ref_106 - price: *ref_198 - location_ids: *ref_163 - fulfillment_ids: *ref_115 - payment_ids: *ref_185 - _description: *ref_111 - tags: *ref_112 - provider: *ref_199 + _description: *ref_107 + price: *ref_199 + location_ids: *ref_164 + fulfillment_ids: *ref_116 + payment_ids: *ref_186 + _description: *ref_112 + tags: *ref_113 + provider: *ref_200 fulfillments: - id: *ref_115 + id: *ref_116 stops: - type: *ref_127 + type: *ref_128 location: - gps: *ref_200 + gps: *ref_201 _description: required: MANDATORY type: object owner: BPP usage: '--' description: Describes the location of stops. - authorization: *ref_201 - _description: *ref_167 + authorization: *ref_202 + _description: *ref_168 vehicle: - category: *ref_202 - make: *ref_187 - model: *ref_188 - registration: *ref_189 - _description: *ref_203 + category: *ref_203 + make: *ref_188 + model: *ref_189 + registration: *ref_190 + _description: *ref_204 variant: required: MANDATORY type: string @@ -44517,34 +44539,34 @@ x-attributes: owner: BAP usage: John Adam description: Name of the customer - _description: *ref_169 - contact: *ref_204 - _description: *ref_172 - agent: *ref_190 - type: *ref_205 - state: *ref_191 - _description: *ref_119 - tags: *ref_129 - quote: *ref_192 + _description: *ref_170 + contact: *ref_205 + _description: *ref_173 + agent: *ref_191 + type: *ref_206 + state: *ref_192 + _description: *ref_120 + tags: *ref_130 + quote: *ref_193 payments: - id: *ref_206 - collected_by: *ref_136 - status: *ref_207 - type: *ref_208 + id: *ref_207 + collected_by: *ref_137 + status: *ref_208 + type: *ref_209 params: - bank_code: *ref_143 - bank_account_number: *ref_144 - virtual_payment_address: *ref_145 - tags: *ref_123 - cancellation_terms: *ref_179 + bank_code: *ref_144 + bank_account_number: *ref_145 + virtual_payment_address: *ref_146 + tags: *ref_124 + cancellation_terms: *ref_180 status: required: MANDATORY type: string owner: BPP usage: COMPLETED description: Describes the order status. - created_at: *ref_209 - updated_at: *ref_210 + created_at: *ref_210 + updated_at: *ref_211 billing: name: required: OPTIONAL @@ -44564,18 +44586,18 @@ x-attributes: owner: BAP usage: 9897867564 description: Describes the contact number of the billable entity - id: *ref_180 - _description: *ref_159 - documents: *ref_195 + id: *ref_181 + _description: *ref_160 + documents: *ref_196 track: context: - location: *ref_181 - domain: *ref_93 - timestamp: *ref_94 - bap_id: *ref_95 - transaction_id: *ref_96 - message_id: *ref_97 - version: *ref_98 + location: *ref_182 + domain: *ref_94 + timestamp: *ref_95 + bap_id: *ref_96 + transaction_id: *ref_97 + message_id: *ref_98 + version: *ref_99 action: required: MANDATORY type: string @@ -44584,10 +44606,10 @@ x-attributes: description: >- Describes the Beckn protocol method being called by the sender and executed at the receiver. - bap_uri: *ref_99 - ttl: *ref_100 - bpp_id: *ref_102 - bpp_uri: *ref_103 + bap_uri: *ref_100 + ttl: *ref_101 + bpp_id: *ref_103 + bpp_uri: *ref_104 message: order_id: required: MANDATORY @@ -44597,13 +44619,13 @@ x-attributes: description: Describes the order ID. on_track: context: - location: *ref_181 - domain: *ref_93 - timestamp: *ref_94 - bap_id: *ref_95 - transaction_id: *ref_96 - message_id: *ref_97 - version: *ref_98 + location: *ref_182 + domain: *ref_94 + timestamp: *ref_95 + bap_id: *ref_96 + transaction_id: *ref_97 + message_id: *ref_98 + version: *ref_99 action: required: MANDATORY type: string @@ -44612,10 +44634,10 @@ x-attributes: description: >- Describes the Beckn protocol method being called by the sender and executed at the receiver. - bap_uri: *ref_99 - ttl: *ref_100 - bpp_id: *ref_102 - bpp_uri: *ref_103 + bap_uri: *ref_100 + ttl: *ref_101 + bpp_id: *ref_103 + bpp_uri: *ref_104 message: tracking: status: diff --git a/api/components/enum/default/index.yaml b/api/components/enum/default/index.yaml index 3797c469..26ad94e0 100644 --- a/api/components/enum/default/index.yaml +++ b/api/components/enum/default/index.yaml @@ -399,60 +399,52 @@ cancel: location: *a1 domain: *a2 message: - # cancellation_reason_id: &a11 - - cancellation: - reason: - descriptor: - code: &a11 - - code: "000" - description: Technical cancellation of orders in case protocol technical failures(BAP/BPP) - reference: location: *a1 domain: *a2 - +support: + context: + action: + - code: support + description: Buyer app requests order support." + reference: + location: *a1 + domain: *a2 + message: + support: + descriptor: &supportCodes + code: + - code: SOS + description: Describes the support code value as SOS + reference: + - code: LONG_HALT + description: Describes the support code value as LONG_HALT + reference: + - code: ROUTE_DEV + description: Describes the support code value as ROUTE_DEV + reference: +on_support: + context: + action: + - code: on_support + description: Buyer app requests order support." + reference: + location: *a1 + domain: *a2 + message: + support: + descriptor: *supportCodes diff --git a/ui/build.js b/ui/build.js index 97d84020..81fde02d 100644 --- a/ui/build.js +++ b/ui/build.js @@ -1 +1 @@ -let build_spec = {"openapi":"3.0.0","info":{"title":"ONDC Specification","description":"ONDC Specification","version":"2.0.0"},"security":[{"SubscriberAuth":[]}],"paths":{"/search":{"post":{"tags":["Provider Platform","Gateway"],"description":"Consumer Platform declares the customer's intent to buy/avail products or services","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"properties":{"action":{"enum":["search"]}}}]},"message":{"type":"object","additionalProperties":false,"properties":{"intent":{"$ref":"#/components/schemas/Intent"}}}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/select":{"post":{"tags":["Provider Platform"],"description":"Consumer Platform declares the customer's cart (or equivalent) created by selecting objects from the catalog","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["select"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/init":{"post":{"tags":["Provider Platform"],"description":"Initialize an order by providing billing and/or shipping details","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["init"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]}},"required":["context","message"]}}}},"responses":{"default":{"description":"Acknowledgement of message received after successful validation of schema and signature","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"object","properties":{"ack":{"allOf":[{"$ref":"#/components/schemas/Ack"},{"type":"object"},{"properties":{"status":{"enum":["ACK","NACK"]}}}]}},"required":["ack"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["message"]}}}}}}},"/confirm":{"post":{"tags":["Provider Platform"],"description":"Initialize an order by providing billing and/or shipping details","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["confirm"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/status":{"post":{"tags":["Provider Platform"],"description":"Fetch the latest order object","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["status"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"ref_id":{"$ref":"#/components/schemas/Order/properties/id"},"order_id":{"$ref":"#/components/schemas/Order/properties/id"}}}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/track":{"post":{"tags":["Provider Platform"],"description":"Track an active order","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["track"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order_id":{"$ref":"#/components/schemas/Order/properties/id"},"callback_url":{"type":"string","format":"uri"}},"required":["order_id"]}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/cancel":{"post":{"tags":["Provider Platform"],"description":"Cancel an order","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["cancel"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order_id":{"$ref":"#/components/schemas/Order/properties/id"},"cancellation_reason_id":{"$ref":"#/components/schemas/Option/properties/id"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"cancellation":{"description":"The cancellation details of this order","allOf":[{"$ref":"#/components/schemas/Cancellation"}]}},"required":["order_id"]}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/update":{"post":{"tags":["Provider Platform"],"description":"Remove object","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["update"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"update_target":{"description":"Comma separated values of order objects being updated. For example: ```\"update_target\":\"item,billing,fulfillment\"```","type":"string"},"order":{"description":"Updated order object","allOf":[{"$ref":"#/components/schemas/Order"}]}},"required":["update_target","order"]}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/rating":{"post":{"tags":["Provider Platform"],"description":"Provide feedback on a service","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["rating"]}},"required":["action"]}]},"message":{"type":"object","properties":{"order_id":{"$ref":"#/components/schemas/Order/properties/id"},"ratings":{"type":"array","items":{"$ref":"#/components/schemas/Rating"}}}}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/support":{"post":{"tags":["Provider Platform"],"description":"Contact support","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["support"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"support":{"$ref":"#/components/schemas/Support"}}}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_search":{"post":{"tags":["Consumer Platform"],"description":"Provider Platform sends its catalog in response to a search request.","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_search"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"catalog":{"$ref":"#/components/schemas/Catalog"}},"required":["catalog"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_select":{"post":{"tags":["Consumer Platform"],"description":"Send draft order object with quoted price for selected items","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_select"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}}},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_init":{"post":{"tags":["Consumer Platform"],"description":"Send order object with payment details updated","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_init"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_confirm":{"post":{"tags":["Consumer Platform"],"description":"Send active order object","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_confirm"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_track":{"post":{"tags":["Consumer Platform"],"description":"Send tracking details of an active order","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_track"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"tracking":{"$ref":"#/components/schemas/Tracking"}},"required":["tracking"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_cancel":{"post":{"tags":["Consumer Platform"],"description":"Send cancellation request_id with reasons list in case of cancellation request. Else send cancelled order object","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_cancel"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_update":{"post":{"tags":["Consumer Platform"],"description":"Returns updated service with updated runtime object","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_update"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_status":{"post":{"tags":["Consumer Platform"],"description":"Fetch the status of a Service","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_status"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_rating":{"post":{"tags":["Consumer Platform"],"description":"Provide feedback on a service","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_rating"]}},"required":["action"]}]},"message":{"type":"object","properties":{"order_id":{"$ref":"#/components/schemas/Order/properties/id"},"ratings":{"type":"array","items":{"$ref":"#/components/schemas/Rating"}}}},"error":{"$ref":"#/components/schemas/Error"}},"required":["context"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_support":{"post":{"tags":["Consumer Platform"],"description":"Contact Support","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_support"]}},"required":["action"]}]},"message":{"type":"object","properties":{"support":{"$ref":"#/components/schemas/Support"}}},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}}},"components":{"securitySchemes":{"SubscriberAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Signature of message body using Consumer Platform or Provider Platform subscriber's signing public key.

Format:

Authorization : Signature keyId=\"{subscriber_id}|{unique_key_id}|{algorithm}\",algorithm=\"ed25519\",created=\"1606970629\",expires=\"1607030629\",headers=\"(created) (expires) digest\",signature=\"Base64(signing string)\""}},"schemas":{"Ack":{"description":"Describes the acknowledgement sent in response to an API call. If the implementation uses HTTP/S, then Ack must be returned in the same session. Every API call to a BPP must be responded to with an Ack whether the BPP intends to respond with a callback or not. This has one property called `status` that indicates the status of the Acknowledgement.","type":"object","additionalProperties":false,"properties":{"status":{"type":"string","description":"The status of the acknowledgement. If the request passes the validation criteria of the BPP, then this is set to ACK. If a BPP responds with status = `ACK` to a request, it is required to respond with a callback. If the request fails the validation criteria, then this is set to NACK. Additionally, if a BPP does not intend to respond with a callback even after the request meets the validation criteria, it should set this value to `NACK`.","enum":["ACK","NACK"]},"tags":{"description":"A list of tags containing any additional information sent along with the Acknowledgement.","type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"AddOn":{"description":"Describes an additional item offered as a value-addition to a product or service. This does not exist independently in a catalog and is always associated with an item.","type":"object","additionalProperties":false,"properties":{"id":{"description":"Provider-defined ID of the add-on","type":"string"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"price":{"$ref":"#/components/schemas/Price"},"quantity":{"$ref":"#/components/schemas/ItemQuantity"}}},"Address":{"description":"Describes a postal address.","type":"string"},"Agent":{"description":"Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the BPP wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.","type":"object","additionalProperties":false,"properties":{"person":{"$ref":"#/components/schemas/Person"},"contact":{"$ref":"#/components/schemas/Contact"},"organization":{"$ref":"#/components/schemas/Organization"},"rating":{"$ref":"#/components/schemas/Rating/properties/value"}}},"Authorization":{"description":"Describes an authorization mechanism used to start or end the fulfillment of an order. For example, in the mobility sector, the driver may require a one-time password to initiate the ride. In the healthcare sector, a patient may need to provide a password to open a video conference link during a teleconsultation.","type":"object","additionalProperties":false,"properties":{"type":{"description":"Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy.","type":"string"},"token":{"description":"Token used for authorization. This is typically generated at the BPP. The BAP can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering.","type":"string"},"valid_from":{"description":"Timestamp in RFC3339 format from which token is valid","type":"string","format":"date-time"},"valid_to":{"description":"Timestamp in RFC3339 format until which token is valid","type":"string","format":"date-time"},"status":{"description":"Status of the token","type":"string"}}},"Billing":{"description":"Describes the billing details of an entity.
This has properties like name,organization,address,email,phone,time,tax_number, created_at,updated_at","type":"object","additionalProperties":false,"properties":{"name":{"description":"Name of the billable entity","type":"string"},"organization":{"description":"Details of the organization being billed.","allOf":[{"$ref":"#/components/schemas/Organization"}]},"address":{"description":"The address of the billable entity","allOf":[{"$ref":"#/components/schemas/Address"}]},"state":{"description":"The state where the billable entity resides. This is important for state-level tax calculation","allOf":[{"$ref":"#/components/schemas/State"}]},"city":{"description":"The city where the billable entity resides.","allOf":[{"$ref":"#/components/schemas/City"}]},"email":{"description":"Email address where the bill is sent to","type":"string","format":"email"},"phone":{"description":"Phone number of the billable entity","type":"string"},"time":{"description":"Details regarding the billing period","allOf":[{"$ref":"#/components/schemas/Time"}]},"tax_id":{"description":"ID of the billable entity as recognized by the taxation authority","type":"string"}}},"Cancellation":{"description":"Describes a cancellation event","type":"object","additionalProperties":false,"properties":{"time":{"description":"Date-time when the order was cancelled by the buyer","type":"string","format":"date-time"},"cancelled_by":{"type":"string","enum":["CONSUMER","PROVIDER"]},"reason":{"description":"The reason for cancellation","allOf":[{"$ref":"#/components/schemas/Option"}]},"additional_description":{"description":"Any additional information regarding the nature of cancellation","allOf":[{"$ref":"#/components/schemas/Descriptor"}]}}},"CancellationTerm":{"description":"Describes the cancellation terms of an item or an order. This can be referenced at an item or order level. Item-level cancellation terms can override the terms at the order level.","type":"object","additionalProperties":false,"properties":{"fulfillment_state":{"description":"The state of fulfillment during which this term is applicable.","allOf":[{"$ref":"#/components/schemas/FulfillmentState"}]},"reason_required":{"description":"Indicates whether a reason is required to cancel the order","type":"boolean"},"cancel_by":{"description":"Information related to the time of cancellation.","allOf":[{"$ref":"#/components/schemas/Time"}]},"cancellation_fee":{"$ref":"#/components/schemas/Fee"},"xinput":{"$ref":"#/components/schemas/XInput"},"external_ref":{"$ref":"#/components/schemas/MediaFile"},"cancellation_eligible":{"description":"Indicates if cancellation is eligible","type":"boolean"}}},"Catalog":{"description":"Describes the products or services offered by a BPP. This is typically sent as the response to a search intent from a BAP. The payment terms, offers and terms of fulfillment supported by the BPP can also be included here. The BPP can show hierarchical nature of products/services in its catalog using the parent_category_id in categories. The BPP can also send a ttl (time to live) in the context which is the duration for which a BAP can cache the catalog and use the cached catalog.
This has properties like bbp/descriptor,bbp/categories,bbp/fulfillments,bbp/payments,bbp/offers,bbp/providers and exp
This is used in the following situations.
  • This is typically used in the discovery stage when the BPP sends the details of the products and services it offers as response to a search intent from the BAP.
","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"fulfillments":{"description":"Fulfillment modes offered at the BPP level. This is used when a BPP itself offers fulfillments on behalf of the providers it has onboarded.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment"}},"payments":{"description":"Payment terms offered by the BPP for all transactions. This can be overriden at the provider level.","type":"array","items":{"$ref":"#/components/schemas/Payment"}},"offers":{"description":"Offers at the BPP-level. This is common across all providers onboarded by the BPP.","type":"array","items":{"$ref":"#/components/schemas/Offer"}},"providers":{"type":"array","items":{"$ref":"#/components/schemas/Provider"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}},"exp":{"description":"Timestamp after which catalog will expire","type":"string","format":"date-time"},"ttl":{"description":"Duration in seconds after which this catalog will expire","type":"string"}}},"Category":{"description":"A label under which a collection of items can be grouped.","type":"object","additionalProperties":false,"properties":{"id":{"description":"ID of the category","type":"string"},"parent_category_id":{"$ref":"#/components/schemas/Category/properties/id"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"time":{"$ref":"#/components/schemas/Time"},"ttl":{"description":"Time to live for an instance of this schema"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"Circle":{"description":"Describes a circular region of a specified radius centered at a specified GPS coordinate.","type":"object","additionalProperties":false,"properties":{"gps":{"$ref":"#/components/schemas/Gps"},"radius":{"$ref":"#/components/schemas/Scalar"}}},"City":{"description":"Describes a city","type":"object","additionalProperties":false,"properties":{"name":{"description":"Name of the city","type":"string"},"code":{"description":"City code","type":"string"}}},"Contact":{"description":"Describes the contact information of an entity","type":"object","additionalProperties":false,"properties":{"phone":{"type":"string"},"email":{"type":"string"},"jcard":{"type":"object","additionalProperties":false,"description":"A Jcard object as per draft-ietf-jcardcal-jcard-03 specification"}}},"Context":{"description":"Every API call in beckn protocol has a context. It provides a high-level overview to the receiver about the nature of the intended transaction. Typically, it is the BAP that sets the transaction context based on the consumer's location and action on their UI. But sometimes, during unsolicited callbacks, the BPP also sets the transaction context but it is usually the same as the context of a previous full-cycle, request-callback interaction between the BAP and the BPP. The context object contains four types of fields.
  1. Demographic information about the transaction using fields like `domain`, `country`, and `region`.
  2. Addressing details like the sending and receiving platform's ID and API URL.
  3. Interoperability information like the protocol version that implemented by the sender and,
  4. Transaction details like the method being called at the receiver's endpoint, the transaction_id that represents an end-to-end user session at the BAP, a message ID to pair requests with callbacks, a timestamp to capture sending times, a ttl to specifiy the validity of the request, and a key to encrypt information if necessary.
This object must be passed in every interaction between a BAP and a BPP. In HTTP/S implementations, it is not necessary to send the context during the synchronous response. However, in asynchronous protocols, the context must be sent during all interactions,","type":"object","additionalProperties":false,"properties":{"domain":{"description":"Domain code that is relevant to this transaction context","allOf":[{"$ref":"#/components/schemas/Domain/properties/code","type":"string"}]},"location":{"description":"The location where the transaction is intended to be fulfilled.","allOf":[{"$ref":"#/components/schemas/Location"}]},"action":{"description":"The Beckn protocol method being called by the sender and executed at the receiver.","type":"string"},"version":{"type":"string","description":"Version of transaction protocol being used by the sender."},"bap_id":{"description":"Subscriber ID of the BAP","allOf":[{"description":"A globally unique identifier of the platform, Typically it is the fully qualified domain name (FQDN) of the platform.","type":"string"}]},"bap_uri":{"description":"Subscriber URL of the BAP for accepting callbacks from BPPs.","allOf":[{"description":"The callback URL of the Subscriber. This should necessarily contain the same domain name as set in `subscriber_id``.","type":"string","format":"uri"}]},"bpp_id":{"description":"Subscriber ID of the BPP","allOf":[{"$ref":"#/components/schemas/Context/properties/bap_id/allOf/0"}]},"bpp_uri":{"description":"Subscriber URL of the BPP for accepting calls from BAPs.","allOf":[{"$ref":"#/components/schemas/Context/properties/bap_uri/allOf/0"}]},"transaction_id":{"description":"This is a unique value which persists across all API calls from `search` through `confirm`. This is done to indicate an active user session across multiple requests. The BPPs can use this value to push personalized recommendations, and dynamic offerings related to an ongoing transaction despite being unaware of the user active on the BAP.","type":"string","format":"uuid"},"message_id":{"description":"This is a unique value which persists during a request / callback cycle. Since beckn protocol APIs are asynchronous, BAPs need a common value to match an incoming callback from a BPP to an earlier call. This value can also be used to ignore duplicate messages coming from the BPP. It is recommended to generate a fresh message_id for every new interaction. When sending unsolicited callbacks, BPPs must generate a new message_id.","type":"string","format":"uuid"},"timestamp":{"description":"Time of request generation in RFC3339 format","type":"string","format":"date-time"},"key":{"description":"The encryption public key of the sender","type":"string"},"ttl":{"description":"The duration in ISO8601 format after timestamp for which this message holds valid","type":"string"}}},"Country":{"description":"Describes a country","type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the country"},"code":{"type":"string","description":"Country code as per ISO 3166-1 and ISO 3166-2 format"}}},"Credential":{"description":"Describes a credential of an entity - Person or Organization","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","default":"VerifiableCredential"},"url":{"description":"URL of the credential","type":"string","format":"uri"}}},"Customer":{"description":"Describes a customer buying/availing a product or a service","type":"object","additionalProperties":false,"properties":{"person":{"$ref":"#/components/schemas/Person"},"contact":{"$ref":"#/components/schemas/Contact"}}},"DecimalValue":{"description":"Describes a numerical value in decimal form","type":"string","pattern":"[+-]?([0-9]*[.])?[0-9]+"},"Descriptor":{"description":"Physical description of something.","type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"code":{"type":"string"},"short_desc":{"type":"string"},"long_desc":{"type":"string"},"additional_desc":{"type":"object","additionalProperties":false,"properties":{"url":{"type":"string"},"content_type":{"type":"string","enum":["text/plain","text/html","application/json"]}}},"media":{"type":"array","items":{"$ref":"#/components/schemas/MediaFile"}},"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"}}}},"Domain":{"description":"Described the industry sector or sub-sector. The network policy should contain codes for all the industry sectors supported by the network. Domains can be created in varying levels of granularity. The granularity of a domain can be decided by the participants of the network. Too broad domains will result in irrelevant search broadcast calls to BPPs that don't have services supporting the domain. Too narrow domains will result in a large number of registry entries for each BPP. It is recommended that network facilitators actively collaborate with various working groups and network participants to carefully choose domain codes keeping in mind relevance, performance, and opportunity cost. It is recommended that networks choose broad domains like mobility, logistics, healthcare etc, and progressively granularize them as and when the number of network participants for each domain grows large.","type":"object","additionalProperties":false,"properties":{"name":{"description":"Name of the domain","type":"string"},"code":{"description":"Standard code representing the domain. The standard is usually published as part of the network policy. Furthermore, the network facilitator should also provide a mechanism to provide the supported domains of a network."},"additional_info":{"description":"A url that contains addtional information about that domain.","allOf":[{"$ref":"#/components/schemas/MediaFile"}]}}},"Duration":{"description":"Describes duration as per ISO8601 format","type":"string"},"Error":{"description":"Describes an error object that is returned by a BAP, BPP or BG as a response or callback to an action by another network participant. This object is sent when any request received by a network participant is unacceptable. This object can be sent either during Ack or with the callback.","type":"object","additionalProperties":false,"properties":{"code":{"type":"string","description":"Standard error code. For full list of error codes, refer to docs/protocol-drafts/BECKN-005-ERROR-CODES-DRAFT-01.md of this repo\""},"paths":{"type":"string","description":"Path to json schema generating the error. Used only during json schema validation errors"},"message":{"type":"string","description":"Human readable message describing the error. Used mainly for logging. Not recommended to be shown to the user."}}},"Fee":{"description":"A fee applied on a particular entity","type":"object","additionalProperties":false,"properties":{"percentage":{"description":"Percentage of a value","allOf":[{"$ref":"#/components/schemas/DecimalValue"}]},"amount":{"description":"A fixed value","allOf":[{"$ref":"#/components/schemas/Price"}]}}},"Form":{"description":"Describes a form","type":"object","additionalProperties":false,"properties":{"id":{"description":"The form identifier.","type":"string"},"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.","type":"string","format":"uri"},"data":{"description":"The form submission data","type":"object","additionalProperties":true},"mime_type":{"description":"This field indicates the nature and format of the form received by querying the url. MIME types are defined and standardized in IETF's RFC 6838.","type":"string","enum":["text/html","application/html","application/xml","none"]},"resubmit":{"type":"boolean"},"multiple_submissions":{"type":"boolean"}}},"Fulfillment":{"description":"Describes how a an order will be rendered/fulfilled to the end-customer","type":"object","additionalProperties":false,"properties":{"id":{"description":"Unique reference ID to the fulfillment of an order","type":"string"},"type":{"description":"A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. For example, a retail order can be fulfilled either via store pickup or a home delivery. Similarly, a medical consultation can be provided either in-person or via tele-consultation. The network policy must publish standard fulfillment type codes for the different modes of fulfillment.","type":"string"},"rateable":{"description":"Whether the fulfillment can be rated or not","type":"boolean"},"rating":{"description":"The rating value of the fulfullment service.","allOf":[{"$ref":"#/components/schemas/Rating/properties/value"}]},"state":{"description":"The current state of fulfillment. The BPP must set this value whenever the state of the order fulfillment changes and fire an unsolicited `on_status` call.","allOf":[{"$ref":"#/components/schemas/FulfillmentState"}]},"tracking":{"type":"boolean","description":"Indicates whether the fulfillment allows tracking","default":false},"customer":{"description":"The person that will ultimately receive the order","allOf":[{"$ref":"#/components/schemas/Customer"}]},"agent":{"description":"The agent that is currently handling the fulfillment of the order","allOf":[{"$ref":"#/components/schemas/Agent"}]},"contact":{"$ref":"#/components/schemas/Contact"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"stops":{"description":"The list of logical stops encountered during the fulfillment of an order.","type":"array","items":{"$ref":"#/components/schemas/Stop"}},"path":{"description":"The physical path taken by the agent that can be rendered on a map. The allowed format of this property can be set by the network.","type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"FulfillmentState":{"description":"Describes the state of fulfillment","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string","description":"ID of entity which changed the state"}}},"Gps":{"description":"Describes a GPS coordinate","type":"string","pattern":"^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?),\\s*[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$"},"Image":{"description":"Describes an image","type":"object","additionalProperties":false,"properties":{"url":{"description":"URL to the image. This can be a data url or an remote url","type":"string","format":"uri"},"size_type":{"description":"The size of the image. The network policy can define the default dimensions of each type","type":"string","enum":["xs","sm","md","lg","xl","custom"]},"width":{"description":"Width of the image in pixels","type":"string"},"height":{"description":"Height of the image in pixels","type":"string"}}},"Intent":{"description":"The intent to buy or avail a product or a service. The BAP can declare the intent of the consumer containing
  • What they want (A product, service, offer)
  • Who they want (A seller, service provider, agent etc)
  • Where they want it and where they want it from
  • When they want it (start and end time of fulfillment
  • How they want to pay for it

This has properties like descriptor,provider,fulfillment,payment,category,offer,item,tags
This is typically used by the BAP to send the purpose of the user's search to the BPP. This will be used by the BPP to find products or services it offers that may match the user's intent.
For example, in Mobility, the mobility consumer declares a mobility intent. In this case, the mobility consumer declares information that describes various aspects of their journey like,
  • Where would they like to begin their journey (intent.fulfillment.start.location)
  • Where would they like to end their journey (intent.fulfillment.end.location)
  • When would they like to begin their journey (intent.fulfillment.start.time)
  • When would they like to end their journey (intent.fulfillment.end.time)
  • Who is the transport service provider they would like to avail services from (intent.provider)
  • Who is traveling (This is not recommended in public networks) (intent.fulfillment.customer)
  • What kind of fare product would they like to purchase (intent.item)
  • What add-on services would they like to avail
  • What offers would they like to apply on their booking (intent.offer)
  • What category of services would they like to avail (intent.category)
  • What additional luggage are they carrying
  • How would they like to pay for their journey (intent.payment)

For example, in health domain, a consumer declares the intent for a lab booking the describes various aspects of their booking like,
  • Where would they like to get their scan/test done (intent.fulfillment.start.location)
  • When would they like to get their scan/test done (intent.fulfillment.start.time)
  • When would they like to get the results of their test/scan (intent.fulfillment.end.time)
  • Who is the service provider they would like to avail services from (intent.provider)
  • Who is getting the test/scan (intent.fulfillment.customer)
  • What kind of test/scan would they like to purchase (intent.item)
  • What category of services would they like to avail (intent.category)
  • How would they like to pay for their journey (intent.payment)
","type":"object","additionalProperties":false,"properties":{"descriptor":{"description":"A raw description of the search intent. Free text search strings, raw audio, etc can be sent in this object.","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"provider":{"description":"The provider from which the customer wants to place to the order from","allOf":[{"$ref":"#/components/schemas/Provider"}]},"fulfillment":{"description":"Details on how the customer wants their order fulfilled","allOf":[{"$ref":"#/components/schemas/Fulfillment"}]},"payment":{"description":"Details on how the customer wants to pay for the order","allOf":[{"$ref":"#/components/schemas/Payment"}]},"category":{"description":"Details on the item category","allOf":[{"$ref":"#/components/schemas/Category"}]},"offer":{"description":"details on the offer the customer wants to avail","allOf":[{"$ref":"#/components/schemas/Offer"}]},"item":{"description":"Details of the item that the consumer wants to order","allOf":[{"$ref":"#/components/schemas/Item"}]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"ItemQuantity":{"description":"Describes the count or amount of an item","type":"object","additionalProperties":false,"properties":{"allocated":{"description":"This represents the exact quantity allocated for purchase of the item.","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"measure":{"$ref":"#/components/schemas/Scalar"}}},"available":{"description":"This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"measure":{"$ref":"#/components/schemas/Scalar"}}},"maximum":{"description":"This represents the maximum quantity allowed for purchase of the item","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":1},"measure":{"$ref":"#/components/schemas/Scalar"}}},"minimum":{"description":"This represents the minimum quantity allowed for purchase of the item","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"measure":{"$ref":"#/components/schemas/Scalar"}}},"selected":{"description":"This represents the quantity selected for purchase of the item","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"measure":{"$ref":"#/components/schemas/Scalar"}}},"unitized":{"description":"This represents the quantity available in a single unit of the item","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":1,"maximum":1},"measure":{"$ref":"#/components/schemas/Scalar"}}}}},"Item":{"description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.","type":"object","additionalProperties":false,"properties":{"id":{"description":"ID of the item.","type":"string"},"parent_item_id":{"description":"ID of the item, this item is a variant of","allOf":[{"$ref":"#/components/schemas/Item/properties/id"}]},"parent_item_quantity":{"description":"The number of units of the parent item this item is a multiple of","allOf":[{"$ref":"#/components/schemas/ItemQuantity"}]},"descriptor":{"description":"Physical description of the item","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"creator":{"description":"The creator of this item","allOf":[{"$ref":"#/components/schemas/Organization"}]},"price":{"description":"The price of this item, if it has intrinsic value","allOf":[{"$ref":"#/components/schemas/Price"}]},"quantity":{"description":"The selling quantity of the item","allOf":[{"$ref":"#/components/schemas/ItemQuantity"}]},"margin":{"description":"The selling margin of the item","allOf":[{"$ref":"#/components/schemas/ItemQuantity"}]},"category_ids":{"description":"Categories this item can be listed under","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Category/properties/id"}]}},"fulfillment_ids":{"description":"Modes through which this item can be fulfilled","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Fulfillment/properties/id"}]}},"location_ids":{"description":"Provider Locations this item is available in","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Location/properties/id"}]}},"payment_ids":{"description":"Payment modalities through which this item can be ordered","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Payment/properties/id"}]}},"add_ons":{"type":"array","items":{"$ref":"#/components/schemas/AddOn"}},"cancellation_terms":{"description":"Cancellation terms of this item","type":"array","items":{"$ref":"#/components/schemas/CancellationTerm"}},"refund_terms":{"description":"Refund terms of this item","type":"array","items":{"description":"Refund term of an item or an order","type":"object","additionalProperties":false,"properties":{"fulfillment_state":{"description":"The state of fulfillment during which this term is applicable.","allOf":[{"$ref":"#/components/schemas/State"}]},"refund_eligible":{"description":"Indicates if cancellation will result in a refund","type":"boolean"},"refund_within":{"description":"Time within which refund will be processed after successful cancellation.","allOf":[{"$ref":"#/components/schemas/Time"}]},"refund_amount":{"$ref":"#/components/schemas/Price"}}}},"replacement_terms":{"description":"Terms that are applicable be met when this item is replaced","type":"array","items":{"$ref":"#/components/schemas/ReplacementTerm"}},"return_terms":{"description":"Terms that are applicable when this item is returned","type":"array","items":{"$ref":"#/components/schemas/ReturnTerm"}},"xinput":{"description":"Additional input required from the customer to purchase / avail this item","allOf":[{"$ref":"#/components/schemas/XInput"}]},"time":{"description":"Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.","allOf":[{"$ref":"#/components/schemas/Time"}]},"rateable":{"description":"Whether this item can be rated","type":"boolean"},"rating":{"description":"The rating of the item","allOf":[{"$ref":"#/components/schemas/Rating/properties/value"}]},"matched":{"description":"Whether this item is an exact match of the request","type":"boolean"},"related":{"description":"Whether this item is a related item to the exactly matched item","type":"boolean"},"recommended":{"description":"Whether this item is a recommended item to a response","type":"boolean"},"ttl":{"description":"Time to live in seconds for an instance of this schema","type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}},"creds":{"type":"array","items":{"$ref":"#/components/schemas/Credential"}}}},"Location":{"description":"The physical location of something","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"map_url":{"description":"The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.","type":"string","format":"uri"},"gps":{"description":"The GPS co-ordinates of this location.","allOf":[{"$ref":"#/components/schemas/Gps"}]},"updated_at":{"type":"string","format":"date-time"},"address":{"description":"The address of this location.","allOf":[{"$ref":"#/components/schemas/Address"}]},"city":{"description":"The city this location is, or is located within","allOf":[{"$ref":"#/components/schemas/City"}]},"district":{"description":"The state this location is, or is located within","type":"string"},"state":{"description":"The state this location is, or is located within","allOf":[{"$ref":"#/components/schemas/State"}]},"country":{"description":"The country this location is, or is located within","allOf":[{"$ref":"#/components/schemas/Country"}]},"area_code":{"type":"string"},"circle":{"$ref":"#/components/schemas/Circle"},"polygon":{"description":"The boundary polygon of this location","type":"string"},"3dspace":{"description":"The three dimensional region describing this location","type":"string"},"rating":{"description":"The rating of this location","allOf":[{"$ref":"#/components/schemas/Rating/properties/value"}]},"time":{"description":"Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Time"}]}}}},"MediaFile":{"description":"This object contains a url to a media file.","type":"object","additionalProperties":false,"properties":{"mimetype":{"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":{"description":"The URL of the file","type":"string","format":"uri"},"signature":{"description":"The digital signature of the file signed by the sender","type":"string"},"dsa":{"description":"The signing algorithm used by the sender","type":"string"}}},"Offer":{"description":"An offer associated with a catalog. This is typically used to promote a particular product and enable more purchases.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"location_ids":{"type":"array","items":{"$ref":"#/components/schemas/Location/properties/id"}},"category_ids":{"type":"array","items":{"$ref":"#/components/schemas/Category/properties/id"}},"item_ids":{"type":"array","items":{"$ref":"#/components/schemas/Item/properties/id"}},"time":{"$ref":"#/components/schemas/Time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"Option":{"description":"Describes a selectable option","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"descriptor":{"$ref":"#/components/schemas/Descriptor"}}},"Order":{"description":"Describes a legal purchase order. It contains the complete details of the legal contract created between the buyer and the seller.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Human-readable ID of the order. This is generated at the BPP layer. The BPP can either generate order id within its system or forward the order ID created at the provider level."},"ref_order_ids":{"description":"A list of order IDs to link this order to previous orders.","type":"array","items":{"type":"string","description":"ID of a previous order"}},"status":{"description":"Status of the order. Allowed values can be defined by the network policy","type":"string","enum":["ACTIVE","COMPLETE","CANCELLED","COMPLETED","SOFT_CANCEL","CANCELLATION_INITIATED","CANCELLATION_REJECTED","SOFT_UPDATE","CONFIRM_UPDATE","UPDATED"]},"type":{"description":"This is used to indicate the type of order being created to BPPs. Sometimes orders can be linked to previous orders, like a replacement order in a retail domain. A follow-up consultation in healthcare domain. A single order part of a subscription order. The list of order types can be standardized at the network level.","type":"string","default":"DEFAULT","enum":["DRAFT","DEFAULT"]},"provider":{"description":"Details of the provider whose catalog items have been selected.","allOf":[{"$ref":"#/components/schemas/Provider"}]},"items":{"description":"The items purchased / availed in this order","type":"array","items":{"$ref":"#/components/schemas/Item"}},"add_ons":{"description":"The add-ons purchased / availed in this order","type":"array","items":{"$ref":"#/components/schemas/AddOn"}},"offers":{"description":"The offers applied in this order","type":"array","items":{"$ref":"#/components/schemas/Offer"}},"billing":{"description":"The billing details of this order","allOf":[{"$ref":"#/components/schemas/Billing"}]},"fulfillments":{"description":"The fulfillments involved in completing this order","type":"array","items":{"$ref":"#/components/schemas/Fulfillment"}},"cancellation":{"description":"The cancellation details of this order","allOf":[{"$ref":"#/components/schemas/Cancellation"}]},"cancellation_terms":{"description":"Cancellation terms of this item","type":"array","items":{"$ref":"#/components/schemas/CancellationTerm"}},"documents":{"type":"array","items":{"description":"Documnents associated to the order","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"mime_type":{"description":"This field indicates the nature and format of the form received by querying the url. MIME types are defined and standardized in IETF's RFC 6838.","type":"string","enum":["text/html","application/html","application/xml","application/pdf"]},"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.","type":"string","format":"uri"}}}},"refund_terms":{"description":"Refund terms of this item","type":"array","items":{"$ref":"#/components/schemas/Item/properties/refund_terms/items"}},"replacement_terms":{"description":"Replacement terms of this item","type":"array","items":{"$ref":"#/components/schemas/ReplacementTerm"}},"return_terms":{"description":"Return terms of this item","type":"array","items":{"$ref":"#/components/schemas/ReturnTerm"}},"quote":{"description":"The mutually agreed upon quotation for this order.","allOf":[{"$ref":"#/components/schemas/Quotation"}]},"payments":{"description":"The terms of settlement for this order","type":"array","items":{"$ref":"#/components/schemas/Payment"}},"created_at":{"description":"The date-time of creation of this order","type":"string","format":"date-time"},"updated_at":{"description":"The date-time of updated of this order","type":"string","format":"date-time"},"xinput":{"description":"Additional input required from the customer to confirm this order","allOf":[{"$ref":"#/components/schemas/XInput"}]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"Organization":{"description":"An organization. Usually a recognized business entity.","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"address":{"description":"The postal address of the organization","allOf":[{"$ref":"#/components/schemas/Address"}]},"state":{"description":"The state where the organization's address is registered","allOf":[{"$ref":"#/components/schemas/State"}]},"city":{"description":"The city where the the organization's address is registered","allOf":[{"$ref":"#/components/schemas/City"}]},"contact":{"$ref":"#/components/schemas/Contact"}}},"Payment":{"description":"Describes the terms of settlement between the BAP and the BPP for a single transaction. When instantiated, this object contains
  1. the amount that has to be settled,
  2. The payment destination destination details
  3. When the settlement should happen, and
  4. A transaction reference ID
. During a transaction, the BPP reserves the right to decide the terms of payment. However, the BAP can send its terms to the BPP first. If the BPP does not agree to those terms, it must overwrite the terms and return them to the BAP. If overridden, the BAP must either agree to the terms sent by the BPP in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the BAP and the BPP can perform offline negotiations on the payment terms. Once an agreement is reached, the BAP and BPP can resume transactions.","type":"object","additionalProperties":false,"properties":{"id":{"description":"ID of the payment term that can be referred at an item or an order level in a catalog","type":"string"},"collected_by":{"description":"This field indicates who is the collector of payment. The BAP can set this value to 'bap' if it wants to collect the payment first and settle it to the BPP. If the BPP agrees to those terms, the BPP should not send the payment url. Alternatively, the BPP can set this field with the value 'bpp' if it wants the payment to be made directly.","type":"string"},"url":{"type":"string","description":"A payment url to be called by the BAP. If empty, then the payment is to be done offline. The details of payment should be present in the params object. If tl_method = http/get, then the payment details will be sent as url params. Two url param values, ```$transaction_id``` and ```$amount``` are mandatory.","format":"uri"},"tl_method":{"type":"string"},"params":{"type":"object","additionalProperties":false,"properties":{"transaction_id":{"type":"string","description":"The reference transaction ID associated with a payment activity"},"amount":{"type":"string"},"currency":{"type":"string"},"bank_code":{"type":"string"},"bank_account_number":{"type":"string"},"virtual_payment_address":{"type":"string"},"source_bank_code":{"type":"string"},"source_bank_account_number":{"type":"string"},"source_virtual_payment_address":{"type":"string"}}},"type":{"type":"string","enum":["PRE_ORDER","PRE_FULFILLMENT","ON_FULFILLMENT","POST_FULFILLMENT","ON_ORDER","PART_PAYMENT","ON_CANCELLATION","POST_CANCELLATION"]},"status":{"type":"string","enum":["PAID","NOT_PAID"]},"time":{"$ref":"#/components/schemas/Time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"Person":{"description":"Describes a person as any individual","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Describes the identity of the person"},"url":{"description":"Profile url of the person","type":"string","format":"uri"},"name":{"description":"the name of the person","type":"string"},"image":{"$ref":"#/components/schemas/Image"},"age":{"description":"Age of the person","allOf":[{"$ref":"#/components/schemas/Duration"}]},"dob":{"description":"Date of birth of the person","type":"string","format":"date"},"gender":{"type":"string","description":"Gender of something, typically a Person, but possibly also fictional characters, animals, etc. While Male and Female may be used, text strings are also acceptable for people who do not identify as a binary gender.Allowed values for this field can be published in the network policy"},"creds":{"type":"array","items":{"$ref":"#/components/schemas/Credential"}},"languages":{"type":"array","items":{"description":"Describes a language known to the person.","type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"name":{"type":"string"}}}},"skills":{"type":"array","items":{"description":"Describes a skill of the person.","type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"name":{"type":"string"}}}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}},"descriptor":{"$ref":"#/components/schemas/Descriptor"}}},"Price":{"description":"Describes the price of a product or service","type":"object","additionalProperties":false,"properties":{"currency":{"type":"string"},"value":{"$ref":"#/components/schemas/DecimalValue"},"estimated_value":{"$ref":"#/components/schemas/DecimalValue"},"computed_value":{"$ref":"#/components/schemas/DecimalValue"},"listed_value":{"$ref":"#/components/schemas/DecimalValue"},"offered_value":{"$ref":"#/components/schemas/DecimalValue"},"minimum_value":{"$ref":"#/components/schemas/DecimalValue"},"maximum_value":{"$ref":"#/components/schemas/DecimalValue"}}},"Provider":{"description":"Describes the catalog of a business.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Id of the provider"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"category_id":{"type":"string","description":"Category Id of the provider at the BPP-level catalog"},"rating":{"$ref":"#/components/schemas/Rating/properties/value"},"time":{"$ref":"#/components/schemas/Time"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"fulfillments":{"type":"array","items":{"$ref":"#/components/schemas/Fulfillment"}},"payments":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"}},"offers":{"type":"array","items":{"$ref":"#/components/schemas/Offer"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"exp":{"type":"string","description":"Time after which catalog has to be refreshed","format":"date-time"},"rateable":{"description":"Whether this provider can be rated or not","type":"boolean"},"ttl":{"description":"The time-to-live in seconds, for this object. This can be overriden at deeper levels. A value of -1 indicates that this object is not cacheable.","type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}},"cancellation_terms":{"description":"Cancellation terms of this item","type":"array","items":{"$ref":"#/components/schemas/CancellationTerm"}}}},"Quotation":{"description":"Describes a quote. It is the estimated price of products or services from the BPP.
This has properties like price, breakup, ttl","type":"object","additionalProperties":false,"properties":{"id":{"description":"ID of the quote.","type":"string"},"price":{"description":"The total quoted price","allOf":[{"$ref":"#/components/schemas/Price"}]},"breakup":{"description":"the breakup of the total quoted price","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"item":{"$ref":"#/components/schemas/Item"},"title":{"type":"string"},"price":{"$ref":"#/components/schemas/Price"}}}},"ttl":{"$ref":"#/components/schemas/Duration"}}},"Rating":{"description":"Describes the rating of an entity","type":"object","additionalProperties":false,"properties":{"rating_category":{"description":"Category of the entity being rated","type":"string","enum":["ITEM","ORDER","FULFILLMENT","PROVIDER","AGENT","SUPPORT"]},"id":{"description":"Id of the object being rated","type":"string"},"value":{"description":"Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.","type":"string"}}},"Region":{"description":"Describes an arbitrary region of space. The network policy should contain a published list of supported regions by the network.","type":"object","additionalProperties":false,"properties":{"dimensions":{"description":"The number of dimensions that are used to describe any point inside that region. The most common dimensionality of a region is 2, that represents an area on a map. There are regions on the map that can be approximated to one-dimensional regions like roads, railway lines, or shipping lines. 3 dimensional regions are rarer, but are gaining popularity as flying drones are being adopted for various fulfillment services.","type":"string","enum":["1","2","3"]},"type":{"description":"The type of region. This is used to specify the granularity of the region represented by this object. Various examples of two-dimensional region types are city, country, state, district, and so on. The network policy should contain a list of all possible region types supported by the network.","type":"string"},"name":{"type":"string","description":"Name of the region as specified on the map where that region exists."},"code":{"type":"string","description":"A standard code representing the region. This should be interpreted in the same way by all network participants."},"boundary":{"type":"string","description":"A string representing the boundary of the region. One-dimensional regions are represented by polylines. Two-dimensional regions are represented by polygons, and three-dimensional regions can represented by polyhedra."},"map_url":{"type":"string","description":"The url to the map of the region. This can be a globally recognized map or the one specified by the network policy."}}},"ReplacementTerm":{"description":"The replacement policy of an item or an order","type":"object","additionalProperties":false,"properties":{"fulfillment_state":{"description":"The state of fulfillment during which this term is applicable.","allOf":[{"$ref":"#/components/schemas/State"}]},"replace_within":{"description":"Applicable only for buyer managed returns where the buyer has to replace the item before a certain date-time, failing which they will not be eligible for replacement","allOf":[{"$ref":"#/components/schemas/Time"}]},"external_ref":{"$ref":"#/components/schemas/MediaFile"}}},"ReturnTerm":{"description":"Describes the return policy of an item or an order","type":"object","additionalProperties":false,"properties":{"fulfillment_state":{"description":"The state of fulfillment during which this term IETF''s applicable.","allOf":[{"$ref":"#/components/schemas/State"}]},"return_eligible":{"description":"Indicates whether the item is eligible for return","type":"boolean"},"return_time":{"description":"Applicable only for buyer managed returns where the buyer has to return the item to the origin before a certain date-time, failing which they will not be eligible for refund.","allOf":[{"$ref":"#/components/schemas/Time"}]},"return_location":{"description":"The location where the item or order must / will be returned to","allOf":[{"$ref":"#/components/schemas/Location"}]},"fulfillment_managed_by":{"description":"The entity that will perform the return","type":"string","enum":["CONSUMER","PROVIDER"]}}},"Scalar":{"description":"Describes a scalar","type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["CONSTANT","VARIABLE"]},"value":{"$ref":"#/components/schemas/DecimalValue"},"estimated_value":{"$ref":"#/components/schemas/DecimalValue"},"computed_value":{"$ref":"#/components/schemas/DecimalValue"},"range":{"type":"object","additionalProperties":false,"properties":{"min":{"$ref":"#/components/schemas/DecimalValue"},"max":{"$ref":"#/components/schemas/DecimalValue"}}},"unit":{"type":"string"}}},"Schedule":{"description":"Describes schedule as a repeating time period used to describe a regularly recurring event. At a minimum a schedule will specify frequency which describes the interval between occurrences of the event. Additional information can be provided to specify the schedule more precisely. This includes identifying the timestamps(s) of when the event will take place. Schedules may also have holidays to exclude a specific day from the schedule.
This has properties like frequency, holidays, times","type":"object","additionalProperties":false,"properties":{"frequency":{"$ref":"#/components/schemas/Duration"},"holidays":{"type":"array","items":{"type":"string","format":"date-time"}},"times":{"type":"array","items":{"type":"string","format":"date-time"}}}},"State":{"description":"A bounded geopolitical region of governance inside a country.","type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the state"},"code":{"type":"string","description":"State code as per country or international standards"}}},"Stop":{"description":"A logical point in space and time during the fulfillment of an order.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"parent_stop_id":{"type":"string"},"location":{"description":"Location of the stop","allOf":[{"$ref":"#/components/schemas/Location"}]},"type":{"description":"The type of stop. Allowed values of this property can be defined by the network policy.","type":"string"},"time":{"description":"Timings applicable at the stop.","allOf":[{"$ref":"#/components/schemas/Time"}]},"instructions":{"description":"Instructions that need to be followed at the stop","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"contact":{"description":"Contact details of the stop","allOf":[{"$ref":"#/components/schemas/Contact"}]},"person":{"description":"The details of the person present at the stop","allOf":[{"$ref":"#/components/schemas/Person"}]},"authorization":{"$ref":"#/components/schemas/Authorization"}}},"Support":{"description":"Details of customer support","type":"object","additionalProperties":false,"properties":{"ref_id":{"type":"string"},"callback_phone":{"type":"string","format":"phone"},"phone":{"type":"string","format":"phone"},"email":{"type":"string","format":"email"},"url":{"type":"string","format":"uri"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"ref_type":{"type":"string"}}},"Tag":{"description":"Describes a tag. This is used to contain extended metadata. This object can be added as a property to any schema to describe extended attributes. For BAPs, tags can be sent during search to optimize and filter search results. BPPs can use tags to index their catalog to allow better search functionality. Tags are sent by the BPP as part of the catalog response in the `on_search` callback. Tags are also meant for display purposes. Upon receiving a tag, BAPs are meant to render them as name-value pairs. This is particularly useful when rendering tabular information about a product or service.","type":"object","additionalProperties":false,"properties":{"descriptor":{"description":"Description of the Tag, can be used to store detailed information.","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"value":{"description":"The value of the tag. This set by the BPP and rendered as-is by the BAP.","type":"string"},"display":{"description":"This value indicates if the tag is intended for display purposes. If set to `true`, then this tag must be displayed. If it is set to `false`, it should not be displayed. This value can override the group display value.","type":"boolean"}}},"TagGroup":{"description":"A collection of tag objects with group level attributes. For detailed documentation on the Tags and Tag Groups schema go to https://github.com/beckn/protocol-specifications/discussions/316","type":"object","additionalProperties":false,"properties":{"display":{"description":"Indicates the display properties of the tag group. If display is set to false, then the group will not be displayed. If it is set to true, it should be displayed. However, group-level display properties can be overriden by individual tag-level display property. As this schema is purely for catalog display purposes, it is not recommended to send this value during search.","type":"boolean","default":true},"descriptor":{"description":"Description of the TagGroup, can be used to store detailed information.","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"list":{"description":"An array of Tag objects listed under this group. This property can be set by BAPs during search to narrow the `search` and achieve more relevant results. When received during `on_search`, BAPs must render this list under the heading described by the `name` property of this schema.","type":"array","items":{"$ref":"#/components/schemas/Tag"}}}},"Time":{"description":"Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operations
This has properties like label, time stamp,duration,range, days, schedule","type":"object","additionalProperties":false,"properties":{"label":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"duration":{"$ref":"#/components/schemas/Duration"},"range":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"days":{"type":"string","description":"comma separated values representing days of the week"},"schedule":{"$ref":"#/components/schemas/Schedule"}}},"Tracking":{"description":"Contains tracking information that can be used by the BAP to track the fulfillment of an order in real-time. which is useful for knowing the location of time sensitive deliveries.","type":"object","additionalProperties":false,"properties":{"id":{"description":"A unique tracking reference number","type":"string"},"url":{"description":"A URL to the tracking endpoint. This can be a link to a tracking webpage, a webhook URL created by the BAP where BPP can push the tracking data, or a GET url creaed by the BPP which the BAP can poll to get the tracking data. It can also be a websocket URL where the BPP can push real-time tracking data.","type":"string","format":"uri"},"location":{"description":"In case there is no real-time tracking endpoint available, this field will contain the latest location of the entity being tracked. The BPP will update this value everytime the BAP calls the track API.","allOf":[{"$ref":"#/components/schemas/Location"}]},"status":{"description":"This value indicates if the tracking is currently active or not. If this value is `active`, then the BAP can begin tracking the order. If this value is `inactive`, the tracking URL is considered to be expired and the BAP should stop tracking the order.","type":"string","enum":["active","inactive"]}}},"Vehicle":{"description":"Describes a vehicle is a device that is designed or used to transport people or cargo over land, water, air, or through space.
This has properties like category, capacity, make, model, size,variant,color,energy_type,registration","type":"object","additionalProperties":false,"properties":{"category":{"type":"string"},"capacity":{"type":"integer"},"make":{"type":"string"},"model":{"type":"string"},"size":{"type":"string"},"variant":{"type":"string"},"color":{"type":"string"},"energy_type":{"type":"string"},"registration":{"type":"string"},"wheels_count":{"type":"string"},"cargo_volumne":{"type":"string"},"wheelchair_access":{"type":"string"},"code":{"type":"string"},"emission_standard":{"type":"string"}}},"XInput":{"description":"Contains any additional or extended inputs required to confirm an order. This is typically a Form Input. Sometimes, selection of catalog elements is not enough for the BPP to confirm an order. For example, to confirm a flight ticket, the airline requires details of the passengers along with information on baggage, identity, in addition to the class of ticket. Similarly, a logistics company may require details on the nature of shipment in order to confirm the shipping. A recruiting firm may require additional details on the applicant in order to confirm a job application. For all such purposes, the BPP can choose to send this object attached to any object in the catalog that is required to be sent while placing the order. This object can typically be sent at an item level or at the order level. The item level XInput will override the Order level XInput as it indicates a special requirement of information for that particular item. Hence the BAP must render a separate form for the Item and another form at the Order level before confirmation.","type":"object","additionalProperties":false,"properties":{"head":{"description":"Provides the header information for the xinput.","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"index":{"type":"object","additionalProperties":false,"properties":{"min":{"type":"integer"},"cur":{"type":"integer"},"max":{"type":"integer"}}},"headings":{"type":"array","items":{"type":"string","description":"The heading names of the forms"}}}},"form":{"$ref":"#/components/schemas/Form"},"form_response":{"description":"Describes the response to a form submission","type":"object","additionalProperties":false,"properties":{"status":{"description":"Contains the status of form submission.","type":"string"},"signature":{"type":"string"},"submission_id":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}},"required":{"description":"Indicates whether the form data is mandatorily required by the BPP to confirm the order.","type":"boolean"}}}}},"x-enum":{"search":{"context":{"action":[{"code":"search","description":"Buyer app indicates the search intent","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"intent":{"category":{"descriptor":{"code":[{"code":"ON_DEMAND_TRIP","description":"Describes the category of the on_demand offer","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"catalog":{"providers":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]}},"on_status":{"context":{"action":[{"code":"on_status","description":"Seller app return order with status , Driver pickup - driver drop","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}]}}}}},"cancel":{"context":{"action":[{"code":"cancel","description":"Buyer app requests order cancellation.\"","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"cancellation":{"reason":{"descriptor":{"code":[{"code":"000","description":"Technical cancellation of orders in case protocol technical failures(BAP/BPP)","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""},{"code":"PROVIDER","description":"Describes, when the ride is cancelled by the provider.","reference":""}],"reason":{"descriptor":{"code":[{"code":"000","description":"Technical cancellation of orders in case protocol technical failures(BAP/BPP)","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]}},"on_track":{"context":{"action":[{"code":"on_track","description":"Seller app specifies the on_track.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]}}},"x-tags":{"search":{"message":{"intent":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"item":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]}]}}}},"on_search":{"message":{"catalog":{"tags":[{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"providers":{"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]}}}}},"on_select":{"message":{"order":{"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"init":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}]}}},"on_init":{"message":{"order":{"tags":[{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"confirm":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"on_confirm":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"on_status":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"on_cancel":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"on_update":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}}},"x-flows":[{"summary":"On-Demand - Assign driver on on-confirm","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"payment_ids":["PA1","PA2"],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"id":"PA1","type":"ON_FULFILLMENT","collected_by":"BPP","status":"NOT_PAID"},{"id":"PA2","type":"POST_CANCELLATION","status":"NOT_PAID","collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver on on-confirm (Add Ons)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"available":{"count":1},"maximum":{"count":1}}}],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"available":{"count":1},"maximum":{"count":1}}}],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"he Buyer App selects a specific service and may optionally choose add-ons","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":1}}}]}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":1}}}]}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":1}}}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver on on-confirm(BAP Collecting)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[BAP Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BAP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[BAP Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[BAP Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BAP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[BAP Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app provides the payment update to Seller app","api":"update","details":[{"description":"Buyer app provides the payment update to Seller app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Buyer app provides the payment update to Seller app","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"47e05cc2-2bc4-41c9-81fb-26be6ae74403","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.payments","order":{"id":"01","payments":[{"collected_by":"BAP","id":"PA1","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"},"status":"PAID","type":"ON_FULFILLMENT"}]}}}}},{"summary":"Seller app provides the latest order status with updated payment details","api":"on_update","details":[{"description":"Seller app provides the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n \n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Seller app provides the latest order status","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver on on-confirm(BAP Collecting, On-Order)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[BAP Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BAP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[BAP Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[BAP Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BAP","status":"NOT_PAID","type":"PRE_ORDER"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[BAP Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"PRE_ORDER"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver on on-confirm(BAP Collecting, Quote-Update)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[BAP Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BAP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[BAP Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[BAP Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BAP","status":"NOT_PAID","type":"PRE_ORDER"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[BAP Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"PRE_ORDER"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride with updated fare details (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}},{"collected_by":"BAP","id":"PA2","status":"NOT_PAID","type":"POST_FULFILLMENT","params":{"amount":"10","currency":"INR"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app provides the payment update to Seller app","api":"update","details":[{"description":"Buyer app provides the payment update to Seller app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Buyer app provides the payment update to Seller app","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"47e05cc2-2bc4-41c9-81fb-26be6ae74403","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.payments","order":{"id":"01","payments":[{"collected_by":"BAP","id":"PA2","params":{"amount":"10","currency":"INR","transaction_id":"3cb81b36-5997-4fa9-9b5f-5b0b1ae25001"},"status":"PAID","type":"POST_FULFILLMENT"}]}}}}},{"summary":"Seller app provides the latest order status with updated payment details","api":"on_update","details":[{"description":"Seller app provides the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n \n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Seller app provides the latest order status","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}},{"collected_by":"BAP","id":"PA2","params":{"amount":"10","currency":"INR","transaction_id":"3cb81b36-5997-4fa9-9b5f-5b0b1ae25001"},"status":"PAID","type":"POST_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver post on-confirm","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"payment_ids":["PA1","PA2"],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"id":"PA1","type":"ON_FULFILLMENT","collected_by":"BPP","status":"NOT_PAID"},{"id":"PA2","type":"POST_CANCELLATION","status":"NOT_PAID","collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:48:34.53Z","tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the latest update on ride details to the buyer app.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy"}},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Assign driver post on-confirm(Self-Pickup)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"On Demand"}}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"payments":[{"collected_by":"BPP"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}]}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}]}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the latest update on ride details to the buyer app.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_status","details":[{"description":"Ride provider provides the latest update on ride details to the buyer app with fulfillment state - RIDE_STARTED","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"PAID","type":"ON_FULFILLMENT","params":{"amount":"146"}}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Female Driver Flow","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"customer":{"person":{"gender":"FEMALE"}},"agent":{"person":{"gender":"FEMALE"}},"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}},{"id":"F3","customer":{"person":{"gender":"FEMALE"}},"agent":{"person":{"gender":"FEMALE"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"CAB Economy Ride – Female Driver"},"category_ids":["C1"],"fulfillment_ids":["F3"],"id":"I3","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"matched":true,"recommended":false},{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"matched":false,"recommended":true},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"matched":false,"recommended":true}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Ride cancellation by driver","details":[{"description":"Detailed process of cancelling a ride with soft & confirm status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel (unsolicited)\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK "}],"steps":[{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel (unsolicited)\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider accepts the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel (unsolicited)\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end "}],"reference":"if any","example":{"summary":"Return current order status after confirm-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"0"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"0"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"PROVIDER","reason":{"descriptor":{"code":"013"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Ride cancellation by rider","details":[{"description":"Detailed process of cancelling a ride with soft & confirm status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app cancels the request for ride","api":"cancel","details":[{"description":"Buyer app requests for cancellation of ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with soft cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts/appends the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after soft-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the cancel request for ride","api":"cancel","details":[{"description":"Buyer app give the confirmation to cancel the ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with confirm cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"CONFIRM_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after confirm-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"ACTIVE","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Technical Cancellation Flow","details":[{"description":"Detailed process of cancelling a ride with soft & confirm status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): NACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK \n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK "}],"reference":"if any","steps":[{"summary":"Provider confirms the request","api":"on_confirm","details":[{"description":"The provider has confirmed the request, but the buyer app received the request after the TTL had expired.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): NACK \n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK "}],"reference":"if any","example":{"value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app request for latest order status","api":"status","details":[{"description":"Buyer app request for latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): NACK \n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK "}],"reference":"if any","example":{"value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"ref_id":"870782be-6757-43f1-945c-8eeaf9536259"}}}},{"summary":"Provider sends the latest order status","api":"on_status","details":[{"description":"Provider sends the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): NACK \n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app cancels the request for ride(Optional)","api":"cancel","details":[{"description":"Buyer app requests for cancellation of ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8bbe4998-6243-4ce6-9859-c0f21c06d3db","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"000"}}},"descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Provider accepts/appends the terms of cancellation(Optional)","api":"on_cancel","details":[{"description":"Provider accepts the terms of order and appends its own terms and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"000"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the cancel request for ride","api":"cancel","details":[{"description":"Buyer app give the confirmation to cancel the ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8bbe4998-6243-4ce6-9859-c0f21c06d3db","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"000"}}},"descriptor":{"code":"CONFIRM_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Provider accepts the terms of cancellation","api":"on_cancel","details":[{"description":"Provider accepts the terms of order and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end "}],"reference":"if any","example":{"value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"000"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"Driver not found on on_confirm","references":"if any","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","reference":"if any","api":"on_confirm","example":{"value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"error":{"code":"90203","message":"Driver not assigned to the order"}}},"details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}]}]},{"summary":"Driver not found post on_confirm","references":"if any","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","reference":"if any","api":"on_confirm","example":{"value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:48:34.53Z","tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},"details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}]},{"summary":"Ride not found after on_confirm","reference":"if any","api":"on_cancel","example":{"value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"PROVIDER","reason":{"descriptor":{"code":"011"}}},"created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},"details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}]}]},{"summary":"On-Demand - Ride with multiple stops","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816","address":"XYZ, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END","id":"3","parent_stop_id":"2"}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","category_ids":["C1"],"location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","category_ids":["C1"],"location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","category_ids":["C1"],"location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Update Stop","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app requests for update of stop","api":"update","details":[{"description":"Buyer app request the provider platform to update the stop","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With fulfillment id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Update an active ride","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.fulfillments","order":{"id":"01","status":"SOFT_UPDATE","fulfillments":[{"id":"F1","stops":[{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}]}]}}}}},{"summary":"Provider platform confirms with on_update request","api":"on_update","details":[{"description":"Provider platform provides the updated order details","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"SOFT_UPDATE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for update of stop","api":"update","details":[{"description":"Buyer app request the provider platform to update the stop","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With fulfillment id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Update an active ride","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"47e05cc2-2bc4-41c9-81fb-26be6ae74403","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.fulfillments","order":{"id":"01","status":"CONFIRM_UPDATE","fulfillments":[{"id":"F1","stops":[{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}]}]}}}}},{"summary":"Provider platform confirms with on_update request","api":"on_update","details":[{"description":"Provider platform provides the updated order details","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"UPDATED","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Provider platform provide the latest order status","api":"on_status","details":[{"description":"Provider platform provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Pre Order Bid","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"payment_ids":["PA1","PA2"],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"id":"PA1","type":"ON_FULFILLMENT","collected_by":"BPP","status":"NOT_PAID"},{"id":"PA2","type":"POST_CANCELLATION","status":"NOT_PAID","collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","price":{"currency":"INR","value":"166"}}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"166"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"20"},"title":"BUYER_ADDITIONAL_AMOUNT"}],"price":{"currency":"INR","value":"166"},"ttl":"PT30S"}}}}}}]},{"summary":"On-Demand - Post Order Tip","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for update of quote (tipping)","api":"update","details":[{"description":"Buyer app requests for update of quote (tipping)","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With order id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated quote\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Update an active ride","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.quote.breakup","order":{"id":"O1","quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"20"},"title":"BUYER_ADDITIONAL_AMOUNT"}],"price":{"currency":"INR","value":"166"}}}}}}},{"summary":"Provider platform confirms with on_update request","api":"on_update","details":[{"description":"Provider platform provides the updated order details","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update quote\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated quote\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"PT60M"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"Delivery"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"DELAY_INTEREST"},"value":"2.5"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"1.46"},{"descriptor":{"code":"SETTLEMENT_BANK_CODE"},"value":"XXXXXXXX"},{"descriptor":{"code":"SETTLEMENT_BANK_ACCOUNT_NUMBER"},"value":"xxxxxxxxxxxxxx"},{"descriptor":{"code":"SETTLEMENT_VIRTUAL_PAYMENT_ADDRESS"},"value":"9988199772@okicic"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"20"},"title":"BUYER_ADDITIONAL_AMOUNT"}],"price":{"currency":"INR","value":"166"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Rental","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_RENTAL"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"circle":{"gps":"13.008935, 77.644408","radius":{"type":"CONSTANT","value":"100","unit":"KILOMETER"}}},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"category_ids":["C3"],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C3"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"add_ons":[{"id":"A2","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"1","unit":"HOURS"}}},"descriptor":{"name":"time","code":"TIME"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C3","descriptor":{"code":"ON_DEMAND_RENTAL","name":"Rental"}}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","category_ids":["C3"],"location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"Schedule - Rental","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"SCHEDULED_RENTAL"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C4"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"add_ons":[{"id":"A2","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"1","unit":"HOURS"}}},"descriptor":{"name":"time","code":"TIME"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C4","descriptor":{"code":"SCHEDULED_RENTAL","name":"Rental"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides the agent details","api":"on_update","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"4ce7055d-2511-4586-b18f-b50822048447","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACKs\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"Schedule - Trip","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title schedule Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"SCHEDULED_TRIP"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"}},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C2"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C2","descriptor":{"code":"SCHEDULED_TRIP","name":"scheduled"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides the agent details","api":"on_update","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n \n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Rental(when end stop gps coordinate is present)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_RENTAL"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"category_ids":["C3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C3"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"add_ons":[{"id":"A2","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"1","unit":"HOURS"}}},"descriptor":{"name":"time","code":"TIME"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C3","descriptor":{"code":"ON_DEMAND_RENTAL","name":"Rental"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"No Acceptance - Soft_Cancel","details":[{"description":"Detailed process of No Acceptance flow atter soft_cancel.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app cancels the request for ride","api":"cancel","details":[{"description":"Buyer app requests for cancellation of ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with soft cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts/appends the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return current order status after soft-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider sends unsolicited on_status call","api":"on_status","details":[{"description":"The ride provider sends an unsolicited on_status call and reverted to the original order state as no response was received from the buyer app within the defined TTL.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after soft-cancel","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"975ff507-439e-4933-acf4-4aaed4af0d51","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"No Acceptance - Soft_Update","details":[{"description":"Detailed process of No Acceptance flow atter soft_update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With fulfillment id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app requests for update of stop","api":"update","details":[{"description":"Buyer app request the provider platform to update the stop","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With fulfillment id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Update an active ride","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.fulfillments","order":{"id":"01","status":"SOFT_UPDATE","fulfillments":[{"id":"F1","stops":[{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}]}]}}}}},{"summary":"Provider platform confirms with on_update request","api":"on_update","details":[{"description":"Provider platform provides the updated order details","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"SOFT_UPDATE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider sends unsolicited on_status call","api":"on_status","details":[{"description":"The ride provider sends an unsolicited on_status call and reverted to the original order state as no response was received from the buyer app within the defined TTL.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"a6ef2152-7cec-4560-b0ec-04fb13691813","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"BPP Collecting - Payment Confirmation","details":[{"description":"The illustrative flow depicts the comprehensive process of payment confirmation, showcasing the sequential steps and interactions involved in a payment transaction.","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP) ->> Buyer Platform (BAP) : form"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Buyer Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP) ->> Buyer Platform (BAP) : form"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Buyer Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app redirects to payment gateway page.","api":"form","details":[{"description":"Buyer app redirects to payment gateway page using the link provided in the previous step.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP) ->> Buyer Platform (BAP) : form\n end"}],"reference":"if any","example":{"value":"This will redirected to different html page"}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"ref_id":"870782be-6757-43f1-945c-8eeaf9536259"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Buyer Collecting]","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c","amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"}}}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"9a7be37d-f228-432b-9aa9-65144d48da38","timestamp":"2023-12-10T04:34:49.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"9a7be37d-f228-432b-9aa9-65144d48da38","timestamp":"2023-12-10T04:34:52.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c","amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T04:34:52.031Z","updated_at":"2023-12-10T04:34:52.031Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Purple Tags (Assign driver on on-confirm)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"eb60e750-2b11-4170-8bd3-b4c6370835d9","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare & list of supported purple tags.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"eb60e750-2b11-4170-8bd3-b4c6370835d9","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"category_ids":["C5"],"tags":[{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"}},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"}},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"}},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"}}]},{"descriptor":{"name":"Dwarfism","code":"DISABILITY_DWARFISM"},"display":false,"list":[{"descriptor":{"code":"DWARFISM_SPECIAL_REQUIREMENT","name":"Dwarfism","short_desc":"Custom description"}}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C5"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C5","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service & select specific purple tags.","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"01c1903c-f943-4c11-8e93-dff5ce3c30bd","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","tags":[{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"01c1903c-f943-4c11-8e93-dff5ce3c30bd","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"category_ids":["C5"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"category_ids":["C5"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}] "}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"category_ids":["C5"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Ride cancellation by rider(BAP Collecting)","details":[{"description":"Detailed process of cancelling a ride with soft & confirm status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app cancels the request for ride","api":"cancel","details":[{"description":"Buyer app requests for cancellation of ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with soft cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts/appends the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after soft-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"},{"collected_by":"BAP","id":"PA2","status":"NOT_PAID","type":"POST_CANCELLATION"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the cancel request for ride","api":"cancel","details":[{"description":"Buyer app give the confirmation to cancel the ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with confirm cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"CONFIRM_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after confirm-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"},{"collected_by":"BAP","id":"PA2","status":"NOT_PAID","type":"POST_CANCELLATION"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"ACTIVE","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app shares the updated payment status with Seller app.","api":"update","details":[{"description":"Buyer app shares the updated payment status with Seller app.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Buyer app shares the updated payment status with Seller app.","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"396a3c9a-838d-46cd-8fd9-311b93cdb2d0","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.payments","order":{"id":"01","payments":[{"collected_by":"BAP","id":"PA2","params":{"amount":"10","currency":"INR","transaction_id":"ed8bebf6-1ed8-48d0-8506-e0bc35d93d60"},"status":"PAID","type":"POST_CANCELLATION"}]}}}}},{"summary":"Seller app shares the updated order status.","api":"on_update","details":[{"description":"Seller app shares the updated order status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Seller app shares the updated order status.","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"396a3c9a-838d-46cd-8fd9-311b93cdb2d0","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"},{"collected_by":"BAP","id":"PA2","params":{"amount":"10","currency":"INR","transaction_id":"ed8bebf6-1ed8-48d0-8506-e0bc35d93d60"},"status":"PAID","type":"POST_CANCELLATION"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Support","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"The Buyer App initiates the support request","api":"support","details":[{"description":"The Buyer App initiates the support request","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): support\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_support\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"support","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"396a3c9a-838d-46cd-8fd9-311b93cdb2d0","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"support":{"descriptor":{"code":"SOS","name":"sos emergency","short_desc":"Driver has deviated from the planned route."},"ref_type":"ORDER","ref_id":"O1"}}}}},{"summary":"The Seller App returns the on_support response to the Buyer App.","api":"on_support","details":[{"description":"The Seller App returns the on_support response to the Buyer App.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): support\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_support\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_support","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"396a3c9a-838d-46cd-8fd9-311b93cdb2d0","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"support":{"descriptor":{"code":"SOS","name":"sos emergency","short_desc":"Driver has deviated from the planned route."},"ref_type":"ORDER","ref_id":"O1","email":"support@example-bpp.com","phone":"+918068870525","url":"https://example-bpp.com/prod/seller/gethelp"}}}}}]}],"x-examples":{"on-demand":{"summary":"On Demand Use Case Specification","description":"The On-demand use case on the network would enable NPs to perform on-demand ride hailing related transactions on the network. These APIs are utilized by consumer and provider platforms enabling every consumer/ end-user on all consumer platforms to consume the services/ inventory provided by all provider platforms on the network seamlessly. Consumer platforms shall use these specifications to perform transaction operations like discovery, selection, booking, status check and others so as to purchase services/ inventory on the network eg: autos, cabs etc. Provider Platform shall use these specifications to expose their services/ inventory in form of autos or cabs rides. Gateway specifications are used to broadcast demands originating from a consumer platform to all applicable provider platforms in a transparent and unbiased manner.","example_set":{"cancel":{"examples":[{"summary":"Initiates_cancelling_a_ride_with_confirm_cancel_status___X5","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"CONFIRM_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}},{"summary":"Initiates_cancelling_a_ride_with_soft_cancel_status___X4","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}]},"confirm":{"examples":[{"summary":"Confirm_ride_booking___X6","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"confirm_buyer_app_confirms_the_booking_and_provides_all_the_required_information_for_confirmation_as_per_the_terms_of_the_order__5","description":"TBD","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"confirm_buyer_app_confirms_the_booking_and_provides_all_the_required_information_for_confirmation_as_per_the_terms_of_the_order__6","description":"TBD","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"9a7be37d-f228-432b-9aa9-65144d48da38","timestamp":"2023-12-10T04:34:49.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"init":{"examples":[{"summary":"Initialize_draft_order_and_request_for_terms_of_service[Seller_Collecting]___X7","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}},{"summary":"init_buyer_app_platform_shares_the_terms_of_order_and_initializes_the_request__1","description":"TBD","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"init_buyer_app_platform_shares_the_terms_of_order_and_initializes_the_request__3","description":"TBD","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"on_cancel":{"examples":[{"summary":"Return_current_order_status_after_confirm-cancel___X9","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"0"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"0"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"PROVIDER","reason":{"descriptor":{"code":"013"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"Return_current_order_status_after_soft-cancel___X8","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"cancel_after_confirm","description":"TBD","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"PROVIDER","reason":{"descriptor":{"code":"011"}}},"created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"on_confirm":{"examples":[{"summary":"Return_confirmed_order_with_latest_fulfillment_details___X10","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"Return_confirmed_order_with_latest_fulfillment_details___X11","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:48:34.53Z","tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"Return_confirmed_order_with_latest_fulfillment_details___X12","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","params":{"amount":"146","currency":"INR","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259"},"status":"PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"DELAY_INTEREST"},"value":"5"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"P2D"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"DELIVERY"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"144.54"},{"descriptor":{"code":"SETTLEMENT_BANK_CODE"},"value":"XXXXXXXX"},{"descriptor":{"code":"SETTLEMENT_BANK_ACCOUNT_NUMBER"},"value":"xxxxxxxxxxxxxx"},{"descriptor":{"code":"SETTLEMENT_VIRTUAL_PAYMENT_ADDRESS"},"value":"9988199772@okicic"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}},{"summary":"on_confirm_ride_provider_confirms_the_ride_request_and_provides_the_ride_details_on_confirmation__6","description":"TBD","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_confirm_ride_provider_confirms_the_ride_request_and_provides_the_ride_details_on_confirmation__7","description":"TBD","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"9a7be37d-f228-432b-9aa9-65144d48da38","timestamp":"2023-12-10T04:34:52.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c","amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T04:34:52.031Z","updated_at":"2023-12-10T04:34:52.031Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"ride_cancelled","description":"TBD","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"error":{"code":"90203","message":"Driver not assigned to the order"}}}]},"on_init":{"examples":[{"summary":"Return_draft_order_with_payment_terms[Seller_Collecting]___X13","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_init_ride_provider_accepts_the_terms_of_order_and_appends_its_own_terms_and_responds_with_the_final_draft__2","description":"TBD","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_init_ride_provider_accepts_the_terms_of_order_and_appends_its_own_terms_and_responds_with_the_final_draft__4","description":"TBD","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}]}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"on_rating":{"examples":[{"summary":"Return_acknowledgement_of_rating_and_feedback___X14","value":{"context":{"action":"on_rating","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"2a17e268-1dc4-4d1a-98a2-17554a50c7d2","timestamp":"2023-03-23T05:41:15Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"feedback_ack":true,"rating_ack":true}}}]},"on_search":{"examples":[{"summary":"Return_a_mobility_catalog[Buyer_Collecting]___X16","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BAP"}]}],"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"DELAY_INTEREST"},"value":"5"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"}]}]}}}},{"summary":"Return_a_mobility_catalog[Seller_Collecting]___X15","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"payment_ids":["PA1","PA2"],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"id":"PA1","type":"ON_FULFILLMENT","collected_by":"BPP","status":"NOT_PAID"},{"id":"PA2","type":"POST_CANCELLATION","status":"NOT_PAID","collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_search_ride_providers_which_is_a_mobility_provider_platform_sends_the_catalog_of_all_services_that_can_be_used_for_transit_from_a_to_b_along_with_estimated_fare__1","description":"TBD","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"On Demand"}}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"payments":[{"collected_by":"BPP"}]}]}}}}]},"on_select":{"examples":[{"summary":"Return_a_quote_offered_by_a_provider___X17","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}},{"summary":"on_select_ride_provider_responds_with_detailed_information_and_quote_for_the_specific_service_that_the_buyer_app_would_like_to_avail__2","description":"TBD","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}]}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}]},"on_status":{"examples":[{"summary":"Return_order_with_latest_fulfillment_status_-_Driver_en-route_to_pickup___X19","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP","name":"Driver is en-route to your location"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"PT60M"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"Delivery"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"DELAY_INTEREST"},"value":"2.5"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"174"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}},{"summary":"Return_order_with_latest_status_-_Ride_Ended___X21","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"AUTO_RICKSHAW","make":"Mahindra","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"PT60M"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"Delivery"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"DELAY_INTEREST"},"value":"2.5"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"174"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}},{"summary":"Return_order_with_latest_status_-_Ride_started___X20","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED","name":"Your ride has started"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","params":{"bank_account_number":"xxxxxxxxxxxxxx","bank_code":"XXXXXXXX","virtual_payment_address":"9988199772@okicic"},"status":"NOT_PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"PT60M"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"Delivery"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"DELAY_INTEREST"},"value":"2.5"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"174"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}},{"summary":"Return_order_with_status_-_Driver_at_pickup___X18","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_status_ride_provider_provides_the_latest_update_on_ride_details_to_the_buyer_app_with_fulfillment_state___ride_started_8","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_1","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_10","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"PAID","type":"ON_FULFILLMENT","params":{"amount":"146"}}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_2","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_3","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_4","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_5","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c","amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"}}}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_12","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"on_support":{"examples":[{"summary":"Return_support_information_related_to_an_order___X22","value":{"context":{"action":"on_support","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"support":{"email":"support@nammayatri.in","phone":"+918068870525","url":"https://support.nammayatri.com/gethelp"}}}}]},"on_track":{"examples":[{"summary":"Return_tracking_information_for_an_order___X23","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}]},"on_update":{"examples":[{"summary":"Return_updated_order_with_recomputed_charges___X24","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}},{"summary":"Return_updated_order_with_updated_agent_details___X26","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}},{"summary":"Return_updated_order_with_updated_billing_details___X25","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"email":"jane.doe@example.com","name":"Jane Doe","phone":"+91-9897867564"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"DELAY_INTEREST"},"value":"5"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"P2D"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"DELIVERY"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"1.46"},{"descriptor":{"code":"SETTLEMENT_BANK_CODE"},"value":"XXXXXXXX"},{"descriptor":{"code":"SETTLEMENT_BANK_ACCOUNT_NUMBER"},"value":"xxxxxxxxxxxxxx"},{"descriptor":{"code":"SETTLEMENT_VIRTUAL_PAYMENT_ADDRESS"},"value":"9988199772@okicic"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:53Z","updated_at":"2023-03-23T04:48:53Z"}}}},{"summary":"on_update_ride_provider_provides_the_latest_update_on_ride_details_to_the_buyer_app__7","description":"TBD","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_update_ride_provider_provides_the_updated_order_updates_to_the_buyer_app___can_update_the_quote_in_case_of_fare_update_9","description":"TBD","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"rating":{"examples":[{"summary":"Provide_a_rating___X27","value":{"context":{"action":"rating","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"b462a835-97d6-4479-bec8-9660a0f8513e","timestamp":"2023-03-23T04:46:45Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"id":"b0462745-f6c9-4100-bbe7-4fa3648b6b40","rating_category":"DRIVER","value":4}}},{"summary":"Provide_a_rating_with_feedback_form_data___X28","value":{"context":{"action":"rating","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"849db48a-34c0-454b-86cb-60864482941b","timestamp":"2023-03-23T04:46:45Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"feedback_form":[{"answer":"Driver took me on a route not shown by Google Maps and we reached 10 minutes before time","id":"1"}],"id":"b0462745-f6c9-4100-bbe7-4fa3648b6b40","rating_category":"DRIVER","value":4}}}]},"search":{"examples":[{"summary":"Search_for_mobility_services_by_pickup_and_drop_location[Buyer_Collecting]___X2","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:40:21.452Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"}}}}},{"summary":"Search_for_mobility_services_by_pickup_and_drop_location[Seller_Collecting]___X1","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"select":{"examples":[{"summary":"Get_quote_for_a_specific_product_from_a_mobility_catalog___X3","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}]},"status":{"examples":[{"summary":"Get_latest_fulfillment_status_of_a_booking___X29","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}},{"summary":"status_buyer_app_requests_the_ride_provider_to_provide_the_latest_order_status_4","description":"TBD","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"ref_id":"870782be-6757-43f1-945c-8eeaf9536259"}}}]},"support":{"examples":[{"summary":"Fetch_support_information_related_to_a_particular_order___X30","value":{"context":{"action":"support","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"support":{"ref_id":"7751bd26-3fdc-47ca-9b64-e998dc5abe68"}}}}]},"track":{"examples":[{"summary":"Track_an_active_ride___X31","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}]}}}},"x-attributes":{"on-demand":{"attribute_set":{"search":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"search","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"}},"message":{"intent":{"fulfillment":{"customer":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the customer gender."}}},"agent":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"Describes the type of the stops during the fulfillment of order"},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"12.923608, 77.614629","description":"Describes the GPS co-ordinates of this location."},"address":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2nd & 3rd Floor, 7/6, August Kranti Marg","description":"Describes the address of the location."},"city":{"code":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code."}},"district":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"New Delhi","description":"Describes the district value."},"country":{"code":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"IND","description":"Describes the country code."}},"area_code":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"110049","description":"Describes the area code."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describe the location of the stop"}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"The list of logical stops encountered during the fulfillment of an order."}},"vehicle":{"category":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle category."},"variant":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"OPTIONAL","type":"object","owner":"BAP","usage":"--","description":"Describes a vehicle is a device that is designed or used to transport people or cargo over land, water, air, or through space.
This has properties like category, capacity, make, model, size,variant,color,energy_type,registration"}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"}},"payment":{"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BPP","description":"This field indicates the payment collector. If set to 'bap,' BAP collects first and settles with BPP. If BPP agrees, no payment link is sent. If set to 'bpp,' BPP collects payment directly."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"The terms of settlement for this order"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This helps the system to find out the purpose of the user behind choosing any product or service. By using this intent the system can align relevant options from available products or service."}}}},"on_search":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_search","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"catalog":{"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Mobility Servies BPP","description":"Describes the catalog name."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the catalog's descriptor."}},"providers":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unique Id of the provider."},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"locations":{"id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Indicates provider locations where this item is available."},"gps":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"28.707358, 77.180910","description":"Describes the GPS co-ordinates of this location."},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's locations."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Describes the unique reference ID to the fulfillment of an order"},"customer":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the customer gender."}}},"agent":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."}}},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DELIVERY","description":"A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. "},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"Describes the type of the stops during the fulfillment of order"},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.707358, 77.180910","description":"Describes the GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle category."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"energy_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"CAB","description":"Describes the vehicle energy type."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"}},"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"CAB Economy Ride","description":"Describes the unique code value of the item"},"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the name value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value of price in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value price in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Indicates the locations where this item is available from providers."},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Describes the Unique reference ID for order fulfillment."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"payments":{"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BPP","description":"This field indicates who is the collector of payment. "},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the terms of settlement between the BAP and the BPP for a single transaction"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Denotes settlement amount"}}}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the catalog's description."}}}},"select":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"select","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This decription refers to the comprehensive list of the products or services selected and obtained within the specified order."}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unique Id of the provider."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This describes the complete formulated description of the loan provider whose catalog items have been selected."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the legal contract created between the buyer and the seller."}}}},"on_select":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_select","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the unique code value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value of price in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value of price in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Provider Locations this item is available in"},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unique Id of the provider."},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"DELIVERY","description":"A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. "},"customer":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the customer gender."}}},"agent":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"Describes the type of the stops during the fulfillment of order"},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"Describes the GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle category."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"energy_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"CAB","description":"Describes the vehicle energy type."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency to be paid in of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the order description."}}}},"init":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"init","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This decription refers to the comprehensive list of the products or services selected and obtained within the specified order."}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Id of the provider"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This describes the complete formulated description of the loan provider whose catalog items have been selected."}},"billing":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"John Doe","description":"Name of the billable entity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"The billing details of this order"}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes contact of end-customer"}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes contact of end-customer"}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.707358, 77.180910","description":"The GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes vehicle category"},"variant":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"OPTIONAL","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"}},"payments":{"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Payment status"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Payment Type"},"params":{"bank_code":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the payment params for this order."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"The terms of settlement for this order"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"This refers to the complete description of the legal contract created between the buyer and the seller."}}}},"on_init":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_init","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145-4ea3-45fe-ab3d-7bcf6b9f456b","description":"Describes the unique Id of the item."},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the unique code value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of selected item."},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value of price in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value of price in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Indicates the locations where this item is available from providers."},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unqiue Id of the provider"},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DELIVERY","description":"A code that describes the mode of fulfillment."},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"Describes the GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle category."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"energy_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"CAB","description":"Describes the vehicle energy type."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Describes the name of the customer"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Describes the contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"}}},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency to be paid in of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the price of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Describes the ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Describe the payment Status for particular order"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Describe the payment type for particular order"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the payment params for this order."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"The terms of settlement for this order"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."},"id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."}}}},"confirm":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"confirm","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This decription refers to the comprehensive list of the products or services selected and obtained within the specified order."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the uique Id of the provider."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This describes the complete formulated description of the loan provider whose catalog items have been selected."}},"billing":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"John Doe","description":"Describes the Name of the billable entity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"The billing details of this order"}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"bc08edb1","description":"ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Describe the payment Status for particular order"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Describe the payment type for particular order"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"transaction_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"cda41144","description":"Describes transaction ID associated with payment activity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the payment params for this order."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"The terms of settlement for this order"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Describe the name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes contact of end-customer"}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Describe the contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes contact of end-customer"}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"Describes the type of the stops during the fulfillment of order"},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"The GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes vehicle category"},"variant":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"OPTIONAL","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"This refers to the complete description of the legal contract created between the buyer and the seller."},"id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."}}}},"on_confirm":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_confirm","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Single Journey Ticket","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"SJT","description":"Describes the unique code value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type to be paid in of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Indicates the locations where this item is available from providers."},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"P1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Unique reference ID to the payment of an order"},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"P1","description":"Unique reference ID to the payment of an order"},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Describes the name of the customer"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Describes the contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"John Doe","description":"Describes the name of the agent"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"},"image":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/images","description":"Describes the agent image"},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the size type of image"}},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the agent details."}},"rating":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"5","description":"Describes the agent rating."},"contact":{"phone":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":7845981268,"description":"Describes the contact number of the agent"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent."}},"state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ASSIGNED","description":"Describes the state's code for fulfillment."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the fulfillments description."}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"INTERMEDIATE_STOP","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.707358, 77.180910","description":"The GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"authorization":{"type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"OTP","description":"Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy."},"token":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":232312,"description":"Token used for authorization. This is typically generated at the BPP. The BAP can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering."},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the authorization for a fulfillments stop."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"AUTO_RICKSHAW","description":"Describes vehicle category"},"make":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Bajaj","description":"Describes vehicle manufacturer"},"model":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"compact-re","description":"Describes vehicle model"},"registration":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"HR-20AS-4578","description":"Describes vehicle registration details"},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency to be paid in of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Describes the ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Describe the Payment Status"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Describe the Payment type"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"amount":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":146,"description":"Describes the amount associated with the payment transaction"},"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency associated with the payment transaction"},"transaction_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"cda41144","description":"Describes transaction ID associated with payment activity"}},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"status":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ACTIVE","description":"Describes the order status."},"created_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes the date-time of creation of this order"},"updated_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes The date-time of updated of this order"},"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."}}}},"cancel":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"cancel","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"60253df1","description":"Describes the unique ID of the order. "},"cancellation_reason_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"45dd6fd3","description":"Describes the reason Id for cancellation"},"descriptor":{"short_desc":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"Accidantaly book the ride","description":"Describes the Short description for cancellaion"},"name":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"Ride Cancellation","description":"Describes the name for cancellaion"},"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"SOFT_CANCEL","description":"Describes the code for cancellaion"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This include the details about the distinctive features, benefits, or unique aspects of the products or service that has been offered to the end customer."}}}},"on_cancel":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_cancel","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique ID of the order. "},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the unique code value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Describes the unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Describes the unique reference ID to the payment of an order"},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Provider Locations this item is available in"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type to be paid in of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unique ID of the provider."},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"Describes a GPS coordinate"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"authorization":{"type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"OTP","description":"Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy."},"token":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":232312,"description":"Token used for authorization. This is typically generated at the BPP. The BAP can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering."}},"time":{"duration":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"PT2H","description":"Describes the duration."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the fulfillments stops."}},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"John Doe","description":"Describes the name of the agent"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"},"image":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/images","description":"Describes the agent image"},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the size type of image"}},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the agent details."}},"rating":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"5","description":"Describes the agent rating."},"contact":{"phone":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":7845981268,"description":"Describes the contact number of the agent"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent."}},"vehicle":{"registration":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"HR-20AS-4578","description":"Describes vehicle registration details"},"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"AUTO_RICKSHAW","description":"Describes vehicle category"},"make":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Bajaj","description":"Describes vehicle manufacturer"},"model":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"compact-re","description":"Describes vehicle model"},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the vehicle type."}},"state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DRIVER_ENROUTE","description":"Describes the state's code for fulfillment."},"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Driver is on the way","description":"Describes the current state"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the fulfillments description."}}},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"P1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Describes the Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency type of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"ID of the payment term that can be referred at an item or an order level in a catalog"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Describe the Payment type"},"params":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes currency value in string form"},"amount":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":60,"description":"Describes a numerical value in decimal form"},"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"bank_account_name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Raghvinder J","description":"Describes the Bank account holder name"},"virtual_payment_address":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"}},"time":{"duration":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P1D","description":"Describes time transaction duration"}},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Describe the Payment Status"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."},"status":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"SOFT_CANCEL","description":"Describes the order status."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."},"documents":{"descriptor":{"code":{"required":"OPTIONAL","usage":"INVOICE","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"string"},"name":{"required":"OPTIONAL","usage":"Invoice Document","description":"It refers to the specific name of the document","owner":"BPP","type":"string"},"short_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the concised description of the document","owner":"BPP","type":"string"},"long_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the brief description of the document","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"object"}},"mime_type":{"required":"OPTIONAL","usage":"application/pdf","description":"It refers to the categorization of the document based on its file format and content type.","owner":"BPP","type":"string"},"url":{"required":"OPTIONAL","usage":"https://seller.com/loan/invoice/O1.pdf","description":"This describes the url from where the document can be accessed","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the set of documents that are associated to a particular order","owner":"BPP","type":"object"}}}}},"status":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"status","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"60253df1","description":"Describes the unique ID of the order. "},"ref_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"60253df1","description":"Describes unique id for reference, pre-order this will be transaction ID."}}},"on_status":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_status","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique ID of the item. "},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the item code."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes a numerical value in decimal form"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Provider Locations this item is available in"},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Id of the provider"},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"28.686576, 77.441632","description":"Describes a GPS coordinate"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"CAB","description":"Describes vehicle category"},"make":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Bajaj","description":"Describes vehicle manufacturer"},"model":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"compact-re","description":"Describes vehicle model"},"registration":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"HR-20AS-4578","description":"Describes vehicle registration details"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the vehicle type."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."}},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Jason Roy","description":"Name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BPP","usage":9898657512,"description":"Contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"John Doe","description":"Describes the name of the agent"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"},"image":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/images","description":"Describes the agent image"},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the size type of image"}},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the agent details."}},"rating":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"5","description":"Describes the agent rating."},"contact":{"phone":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":7845981268,"description":"Describes the contact number of the agent"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent."}},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Delivery","description":"Describes type of fullfilment"},"state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DRIVER_ENROUTE","description":"Describes the state's code for fulfillment."},"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Driver is on the way","description":"Describes the current state"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the fulfillments description."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency to be paid in of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"PA1","description":"ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Payment Status"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Payment type"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"transaction_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"cda41144","description":"Describes transaction ID associated with payment activity"},"amount":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":146,"description":"Describes the amount associated with the payment transaction"},"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency associated with the payment transaction"}},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"status":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"ACTIVE","description":"Describes the order status."},"created_at":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes the date-time of creation of this order"},"updated_at":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes The date-time of updated of this order"},"id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."},"documents":{"descriptor":{"code":{"required":"OPTIONAL","usage":"INVOICE","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"string"},"name":{"required":"OPTIONAL","usage":"Invoice Document","description":"It refers to the specific name of the document","owner":"BPP","type":"string"},"short_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the concised description of the document","owner":"BPP","type":"string"},"long_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the brief description of the document","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"object"}},"mime_type":{"required":"OPTIONAL","usage":"application/pdf","description":"It refers to the categorization of the document based on its file format and content type.","owner":"BPP","type":"string"},"url":{"required":"OPTIONAL","usage":"https://seller.com/loan/invoice/O1.pdf","description":"This describes the url from where the document can be accessed","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the set of documents that are associated to a particular order","owner":"BPP","type":"object"}}}}},"update":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_status","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":1,"description":"Describes the unique order id"},"fulfillments":{"customer":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"John Adam","description":"Name of the customer"}}},"_description":{"required":"OPTIONAL","type":"object","owner":"BAP/BPP","usage":"--","description":"Name of the customer"}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the unique order id"}}}},"on_update":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_update","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique ID of the item. "},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name. "},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the item code. "},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes a numerical value in decimal form"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Provider Locations this item is available in"},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Id of the provider"},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"Describes a GPS coordinate"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the location of stops."}},"authorization":{"type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"OTP","description":"Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy."},"token":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":232312,"description":"Token used for authorization. This is typically generated at the BPP. The BAP can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering."},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the authorization for a fulfillments stop."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes vehicle category"},"make":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Bajaj","description":"Describes vehicle manufacturer"},"model":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"compact-re","description":"Describes vehicle model"},"registration":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"HR-20AS-4578","description":"Describes vehicle registration details"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."}},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"John Adam","description":"Name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"John Doe","description":"Describes the name of the agent"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"},"image":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/images","description":"Describes the agent image"},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the size type of image"}},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the agent details."}},"rating":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"5","description":"Describes the agent rating."},"contact":{"phone":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":7845981268,"description":"Describes the contact number of the agent"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent."}},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Delivery","description":"Describes type of fullfilment"},"state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DRIVER_ENROUTE","description":"Describes the state's code for fulfillment."},"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Driver is on the way","description":"Describes the current state"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the fulfillments description."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency to be paid in of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"PA1","description":"ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Payment Status"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Payment type"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"}},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"status":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"COMPLETED","description":"Describes the order status."},"created_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes the date-time of creation of this order"},"updated_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes The date-time of updated of this order"},"billing":{"name":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"John Doe","description":"Describes the Name of the billable entity"},"email":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"jane.doe@example.com","description":"Describes the email of the billable entity"},"phone":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":9897867564,"description":"Describes the contact number of the billable entity"}},"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."},"documents":{"descriptor":{"code":{"required":"OPTIONAL","usage":"INVOICE","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"string"},"name":{"required":"OPTIONAL","usage":"Invoice Document","description":"It refers to the specific name of the document","owner":"BPP","type":"string"},"short_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the concised description of the document","owner":"BPP","type":"string"},"long_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the brief description of the document","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"object"}},"mime_type":{"required":"OPTIONAL","usage":"application/pdf","description":"It refers to the categorization of the document based on its file format and content type.","owner":"BPP","type":"string"},"url":{"required":"OPTIONAL","usage":"https://seller.com/loan/invoice/O1.pdf","description":"This describes the url from where the document can be accessed","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the set of documents that are associated to a particular order","owner":"BPP","type":"object"}}}}},"track":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"track","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"O1","description":"Describes the order ID."}}},"on_track":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_track","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"tracking":{"status":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"O1","description":"Describes the order status."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"28.620976, 77.046732","description":"Describes the gps value."},"updated_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-03-23T05:41:09Z","description":"Describes the updated_at value."}}}}}}}},"x-errorcodes":{"code":[{"Event":"Route Serviceability error","Description":"To & from location not serviceable by Seller application","From":"BPP","code":90201},{"Event":"Tracking not enabled","Description":"Tracking not enabled for any fulfillment in the order","From":"BPP","code":90202},{"Event":"Driver not assigned","Description":"Driver not assigned to the order","From":"BPP","code":90203}]},"x-tlc":{"code":[{"Term":"Payment Collector ","Api":"search/on_search/init/on_init\t","Attribute":"payment.collected_by ","Owner":"Either","Value":"“BAP”, “BPP” ","Description":"If set to “BAP”, it means that the Buyer App will collect payment from the Buyer.\nIf set to “BPP”, it means that the Seller App will collect payment from the Buyer."},{"Term":"Payment Type ","Api":"init/on_init ","Attribute":"payment.type ","Owner":"Either","Value":"“ON-ORDER”, “ON_FULFILLMENT”\n","Description":"How payment is going to be collected from the Buyer. If this parameter is set to “ON-ORDER”, that means it is a pre-paid order, i.e. the payment is collected at the time of order confirmation. If this parameter is set to “ON_FULFILLMENT”, that means it is a pay at the end of the trip, i.e. the payment is collected when the trip ends."},{"Term":"Item Cancellability ","Api":"search/on_search/init/on_init\t","Attribute":"Handled in cancellation terms ","Owner":"Seller App\t","Value":"true/ false\t","Description":"Whether the order for that item can be canceled after being confirmed. If set to “TRUE” that means the Seller allows the Buyer to cancel the order for the item in question, after confirmation."},{"Term":"Static Terms","Api":"search/on_search/init/on_init\t","Attribute":"STATIC_TERMS","Owner":"Seller App & Buyer App","Value":"URL","Description":"This will be the URL of a web-page where the standard Terms and Conditions of the Network Participant - which are not covered in the API Specification (e.g.: indemnity) - will be hosted. These terms will apply to the transaction, in addition to the terms decided through the ONDC Protocol. If there is a conflict between the terms decided through the Protocol, and the Static Terms, the terms decided through the ONDC Protocol will prevail. Also, if there is a conflict between the Static Terms and the ONDC Network Policy or the Static Terms and the Network Participant Agreement, the terms of the ONDC Network Policy or the Network Participant Agreement (as the case may be) will prevail."}]},"x-featureui":{"filenames":["document_sharing.md"]},"x-sandboxui":{"dropdown":[{"environment-name":"staging","link":"https://mobility-staging.ondc.org"}]},"x-changeLog":{"filenames":["TRV10_2.1.0_030924.md"]}} \ No newline at end of file +let build_spec = {"openapi":"3.0.0","info":{"title":"ONDC Specification","description":"ONDC Specification","version":"2.0.0"},"security":[{"SubscriberAuth":[]}],"paths":{"/search":{"post":{"tags":["Provider Platform","Gateway"],"description":"Consumer Platform declares the customer's intent to buy/avail products or services","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"properties":{"action":{"enum":["search"]}}}]},"message":{"type":"object","additionalProperties":false,"properties":{"intent":{"$ref":"#/components/schemas/Intent"}}}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/select":{"post":{"tags":["Provider Platform"],"description":"Consumer Platform declares the customer's cart (or equivalent) created by selecting objects from the catalog","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["select"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/init":{"post":{"tags":["Provider Platform"],"description":"Initialize an order by providing billing and/or shipping details","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["init"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]}},"required":["context","message"]}}}},"responses":{"default":{"description":"Acknowledgement of message received after successful validation of schema and signature","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"object","properties":{"ack":{"allOf":[{"$ref":"#/components/schemas/Ack"},{"type":"object"},{"properties":{"status":{"enum":["ACK","NACK"]}}}]}},"required":["ack"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["message"]}}}}}}},"/confirm":{"post":{"tags":["Provider Platform"],"description":"Initialize an order by providing billing and/or shipping details","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["confirm"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/status":{"post":{"tags":["Provider Platform"],"description":"Fetch the latest order object","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["status"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"ref_id":{"$ref":"#/components/schemas/Order/properties/id"},"order_id":{"$ref":"#/components/schemas/Order/properties/id"}}}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/track":{"post":{"tags":["Provider Platform"],"description":"Track an active order","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["track"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order_id":{"$ref":"#/components/schemas/Order/properties/id"},"callback_url":{"type":"string","format":"uri"}},"required":["order_id"]}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/cancel":{"post":{"tags":["Provider Platform"],"description":"Cancel an order","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["cancel"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order_id":{"$ref":"#/components/schemas/Order/properties/id"},"cancellation_reason_id":{"$ref":"#/components/schemas/Option/properties/id"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"cancellation":{"description":"The cancellation details of this order","allOf":[{"$ref":"#/components/schemas/Cancellation"}]}},"required":["order_id"]}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/update":{"post":{"tags":["Provider Platform"],"description":"Remove object","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["update"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"update_target":{"description":"Comma separated values of order objects being updated. For example: ```\"update_target\":\"item,billing,fulfillment\"```","type":"string"},"order":{"description":"Updated order object","allOf":[{"$ref":"#/components/schemas/Order"}]}},"required":["update_target","order"]}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/rating":{"post":{"tags":["Provider Platform"],"description":"Provide feedback on a service","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["rating"]}},"required":["action"]}]},"message":{"type":"object","properties":{"order_id":{"$ref":"#/components/schemas/Order/properties/id"},"ratings":{"type":"array","items":{"$ref":"#/components/schemas/Rating"}}}}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/support":{"post":{"tags":["Provider Platform"],"description":"Contact support","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["support"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"support":{"$ref":"#/components/schemas/Support"}}}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_search":{"post":{"tags":["Consumer Platform"],"description":"Provider Platform sends its catalog in response to a search request.","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_search"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"catalog":{"$ref":"#/components/schemas/Catalog"}},"required":["catalog"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_select":{"post":{"tags":["Consumer Platform"],"description":"Send draft order object with quoted price for selected items","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_select"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}}},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_init":{"post":{"tags":["Consumer Platform"],"description":"Send order object with payment details updated","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_init"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_confirm":{"post":{"tags":["Consumer Platform"],"description":"Send active order object","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_confirm"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_track":{"post":{"tags":["Consumer Platform"],"description":"Send tracking details of an active order","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_track"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"tracking":{"$ref":"#/components/schemas/Tracking"}},"required":["tracking"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_cancel":{"post":{"tags":["Consumer Platform"],"description":"Send cancellation request_id with reasons list in case of cancellation request. Else send cancelled order object","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_cancel"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_update":{"post":{"tags":["Consumer Platform"],"description":"Returns updated service with updated runtime object","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_update"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_status":{"post":{"tags":["Consumer Platform"],"description":"Fetch the status of a Service","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_status"]}},"required":["action"]}]},"message":{"type":"object","additionalProperties":false,"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"]},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_rating":{"post":{"tags":["Consumer Platform"],"description":"Provide feedback on a service","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_rating"]}},"required":["action"]}]},"message":{"type":"object","properties":{"order_id":{"$ref":"#/components/schemas/Order/properties/id"},"ratings":{"type":"array","items":{"$ref":"#/components/schemas/Rating"}}}},"error":{"$ref":"#/components/schemas/Error"}},"required":["context"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}},"/on_support":{"post":{"tags":["Consumer Platform"],"description":"Contact Support","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/Context"},{"type":"object","properties":{"action":{"enum":["on_support"]}},"required":["action"]}]},"message":{"type":"object","properties":{"support":{"$ref":"#/components/schemas/Support"}}},"error":{"$ref":"#/components/schemas/Error"}},"required":["context","message"]}}}},"responses":{"default":{"$ref":"#/paths/~1init/post/responses/default"}}}}},"components":{"securitySchemes":{"SubscriberAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Signature of message body using Consumer Platform or Provider Platform subscriber's signing public key.

Format:

Authorization : Signature keyId=\"{subscriber_id}|{unique_key_id}|{algorithm}\",algorithm=\"ed25519\",created=\"1606970629\",expires=\"1607030629\",headers=\"(created) (expires) digest\",signature=\"Base64(signing string)\""}},"schemas":{"Ack":{"description":"Describes the acknowledgement sent in response to an API call. If the implementation uses HTTP/S, then Ack must be returned in the same session. Every API call to a BPP must be responded to with an Ack whether the BPP intends to respond with a callback or not. This has one property called `status` that indicates the status of the Acknowledgement.","type":"object","additionalProperties":false,"properties":{"status":{"type":"string","description":"The status of the acknowledgement. If the request passes the validation criteria of the BPP, then this is set to ACK. If a BPP responds with status = `ACK` to a request, it is required to respond with a callback. If the request fails the validation criteria, then this is set to NACK. Additionally, if a BPP does not intend to respond with a callback even after the request meets the validation criteria, it should set this value to `NACK`.","enum":["ACK","NACK"]},"tags":{"description":"A list of tags containing any additional information sent along with the Acknowledgement.","type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"AddOn":{"description":"Describes an additional item offered as a value-addition to a product or service. This does not exist independently in a catalog and is always associated with an item.","type":"object","additionalProperties":false,"properties":{"id":{"description":"Provider-defined ID of the add-on","type":"string"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"price":{"$ref":"#/components/schemas/Price"},"quantity":{"$ref":"#/components/schemas/ItemQuantity"}}},"Address":{"description":"Describes a postal address.","type":"string"},"Agent":{"description":"Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the BPP wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.","type":"object","additionalProperties":false,"properties":{"person":{"$ref":"#/components/schemas/Person"},"contact":{"$ref":"#/components/schemas/Contact"},"organization":{"$ref":"#/components/schemas/Organization"},"rating":{"$ref":"#/components/schemas/Rating/properties/value"}}},"Authorization":{"description":"Describes an authorization mechanism used to start or end the fulfillment of an order. For example, in the mobility sector, the driver may require a one-time password to initiate the ride. In the healthcare sector, a patient may need to provide a password to open a video conference link during a teleconsultation.","type":"object","additionalProperties":false,"properties":{"type":{"description":"Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy.","type":"string"},"token":{"description":"Token used for authorization. This is typically generated at the BPP. The BAP can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering.","type":"string"},"valid_from":{"description":"Timestamp in RFC3339 format from which token is valid","type":"string","format":"date-time"},"valid_to":{"description":"Timestamp in RFC3339 format until which token is valid","type":"string","format":"date-time"},"status":{"description":"Status of the token","type":"string"}}},"Billing":{"description":"Describes the billing details of an entity.
This has properties like name,organization,address,email,phone,time,tax_number, created_at,updated_at","type":"object","additionalProperties":false,"properties":{"name":{"description":"Name of the billable entity","type":"string"},"organization":{"description":"Details of the organization being billed.","allOf":[{"$ref":"#/components/schemas/Organization"}]},"address":{"description":"The address of the billable entity","allOf":[{"$ref":"#/components/schemas/Address"}]},"state":{"description":"The state where the billable entity resides. This is important for state-level tax calculation","allOf":[{"$ref":"#/components/schemas/State"}]},"city":{"description":"The city where the billable entity resides.","allOf":[{"$ref":"#/components/schemas/City"}]},"email":{"description":"Email address where the bill is sent to","type":"string","format":"email"},"phone":{"description":"Phone number of the billable entity","type":"string"},"time":{"description":"Details regarding the billing period","allOf":[{"$ref":"#/components/schemas/Time"}]},"tax_id":{"description":"ID of the billable entity as recognized by the taxation authority","type":"string"}}},"Cancellation":{"description":"Describes a cancellation event","type":"object","additionalProperties":false,"properties":{"time":{"description":"Date-time when the order was cancelled by the buyer","type":"string","format":"date-time"},"cancelled_by":{"type":"string","enum":["CONSUMER","PROVIDER"]},"reason":{"description":"The reason for cancellation","allOf":[{"$ref":"#/components/schemas/Option"}]},"additional_description":{"description":"Any additional information regarding the nature of cancellation","allOf":[{"$ref":"#/components/schemas/Descriptor"}]}}},"CancellationTerm":{"description":"Describes the cancellation terms of an item or an order. This can be referenced at an item or order level. Item-level cancellation terms can override the terms at the order level.","type":"object","additionalProperties":false,"properties":{"fulfillment_state":{"description":"The state of fulfillment during which this term is applicable.","allOf":[{"$ref":"#/components/schemas/FulfillmentState"}]},"reason_required":{"description":"Indicates whether a reason is required to cancel the order","type":"boolean"},"cancel_by":{"description":"Information related to the time of cancellation.","allOf":[{"$ref":"#/components/schemas/Time"}]},"cancellation_fee":{"$ref":"#/components/schemas/Fee"},"xinput":{"$ref":"#/components/schemas/XInput"},"external_ref":{"$ref":"#/components/schemas/MediaFile"},"cancellation_eligible":{"description":"Indicates if cancellation is eligible","type":"boolean"}}},"Catalog":{"description":"Describes the products or services offered by a BPP. This is typically sent as the response to a search intent from a BAP. The payment terms, offers and terms of fulfillment supported by the BPP can also be included here. The BPP can show hierarchical nature of products/services in its catalog using the parent_category_id in categories. The BPP can also send a ttl (time to live) in the context which is the duration for which a BAP can cache the catalog and use the cached catalog.
This has properties like bbp/descriptor,bbp/categories,bbp/fulfillments,bbp/payments,bbp/offers,bbp/providers and exp
This is used in the following situations.
  • This is typically used in the discovery stage when the BPP sends the details of the products and services it offers as response to a search intent from the BAP.
","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"fulfillments":{"description":"Fulfillment modes offered at the BPP level. This is used when a BPP itself offers fulfillments on behalf of the providers it has onboarded.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment"}},"payments":{"description":"Payment terms offered by the BPP for all transactions. This can be overriden at the provider level.","type":"array","items":{"$ref":"#/components/schemas/Payment"}},"offers":{"description":"Offers at the BPP-level. This is common across all providers onboarded by the BPP.","type":"array","items":{"$ref":"#/components/schemas/Offer"}},"providers":{"type":"array","items":{"$ref":"#/components/schemas/Provider"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}},"exp":{"description":"Timestamp after which catalog will expire","type":"string","format":"date-time"},"ttl":{"description":"Duration in seconds after which this catalog will expire","type":"string"}}},"Category":{"description":"A label under which a collection of items can be grouped.","type":"object","additionalProperties":false,"properties":{"id":{"description":"ID of the category","type":"string"},"parent_category_id":{"$ref":"#/components/schemas/Category/properties/id"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"time":{"$ref":"#/components/schemas/Time"},"ttl":{"description":"Time to live for an instance of this schema"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"Circle":{"description":"Describes a circular region of a specified radius centered at a specified GPS coordinate.","type":"object","additionalProperties":false,"properties":{"gps":{"$ref":"#/components/schemas/Gps"},"radius":{"$ref":"#/components/schemas/Scalar"}}},"City":{"description":"Describes a city","type":"object","additionalProperties":false,"properties":{"name":{"description":"Name of the city","type":"string"},"code":{"description":"City code","type":"string"}}},"Contact":{"description":"Describes the contact information of an entity","type":"object","additionalProperties":false,"properties":{"phone":{"type":"string"},"email":{"type":"string"},"jcard":{"type":"object","additionalProperties":false,"description":"A Jcard object as per draft-ietf-jcardcal-jcard-03 specification"}}},"Context":{"description":"Every API call in beckn protocol has a context. It provides a high-level overview to the receiver about the nature of the intended transaction. Typically, it is the BAP that sets the transaction context based on the consumer's location and action on their UI. But sometimes, during unsolicited callbacks, the BPP also sets the transaction context but it is usually the same as the context of a previous full-cycle, request-callback interaction between the BAP and the BPP. The context object contains four types of fields.
  1. Demographic information about the transaction using fields like `domain`, `country`, and `region`.
  2. Addressing details like the sending and receiving platform's ID and API URL.
  3. Interoperability information like the protocol version that implemented by the sender and,
  4. Transaction details like the method being called at the receiver's endpoint, the transaction_id that represents an end-to-end user session at the BAP, a message ID to pair requests with callbacks, a timestamp to capture sending times, a ttl to specifiy the validity of the request, and a key to encrypt information if necessary.
This object must be passed in every interaction between a BAP and a BPP. In HTTP/S implementations, it is not necessary to send the context during the synchronous response. However, in asynchronous protocols, the context must be sent during all interactions,","type":"object","additionalProperties":false,"properties":{"domain":{"description":"Domain code that is relevant to this transaction context","allOf":[{"$ref":"#/components/schemas/Domain/properties/code","type":"string"}]},"location":{"description":"The location where the transaction is intended to be fulfilled.","allOf":[{"$ref":"#/components/schemas/Location"}]},"action":{"description":"The Beckn protocol method being called by the sender and executed at the receiver.","type":"string"},"version":{"type":"string","description":"Version of transaction protocol being used by the sender."},"bap_id":{"description":"Subscriber ID of the BAP","allOf":[{"description":"A globally unique identifier of the platform, Typically it is the fully qualified domain name (FQDN) of the platform.","type":"string"}]},"bap_uri":{"description":"Subscriber URL of the BAP for accepting callbacks from BPPs.","allOf":[{"description":"The callback URL of the Subscriber. This should necessarily contain the same domain name as set in `subscriber_id``.","type":"string","format":"uri"}]},"bpp_id":{"description":"Subscriber ID of the BPP","allOf":[{"$ref":"#/components/schemas/Context/properties/bap_id/allOf/0"}]},"bpp_uri":{"description":"Subscriber URL of the BPP for accepting calls from BAPs.","allOf":[{"$ref":"#/components/schemas/Context/properties/bap_uri/allOf/0"}]},"transaction_id":{"description":"This is a unique value which persists across all API calls from `search` through `confirm`. This is done to indicate an active user session across multiple requests. The BPPs can use this value to push personalized recommendations, and dynamic offerings related to an ongoing transaction despite being unaware of the user active on the BAP.","type":"string","format":"uuid"},"message_id":{"description":"This is a unique value which persists during a request / callback cycle. Since beckn protocol APIs are asynchronous, BAPs need a common value to match an incoming callback from a BPP to an earlier call. This value can also be used to ignore duplicate messages coming from the BPP. It is recommended to generate a fresh message_id for every new interaction. When sending unsolicited callbacks, BPPs must generate a new message_id.","type":"string","format":"uuid"},"timestamp":{"description":"Time of request generation in RFC3339 format","type":"string","format":"date-time"},"key":{"description":"The encryption public key of the sender","type":"string"},"ttl":{"description":"The duration in ISO8601 format after timestamp for which this message holds valid","type":"string"}}},"Country":{"description":"Describes a country","type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the country"},"code":{"type":"string","description":"Country code as per ISO 3166-1 and ISO 3166-2 format"}}},"Credential":{"description":"Describes a credential of an entity - Person or Organization","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","default":"VerifiableCredential"},"url":{"description":"URL of the credential","type":"string","format":"uri"}}},"Customer":{"description":"Describes a customer buying/availing a product or a service","type":"object","additionalProperties":false,"properties":{"person":{"$ref":"#/components/schemas/Person"},"contact":{"$ref":"#/components/schemas/Contact"}}},"DecimalValue":{"description":"Describes a numerical value in decimal form","type":"string","pattern":"[+-]?([0-9]*[.])?[0-9]+"},"Descriptor":{"description":"Physical description of something.","type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"code":{"type":"string"},"short_desc":{"type":"string"},"long_desc":{"type":"string"},"additional_desc":{"type":"object","additionalProperties":false,"properties":{"url":{"type":"string"},"content_type":{"type":"string","enum":["text/plain","text/html","application/json"]}}},"media":{"type":"array","items":{"$ref":"#/components/schemas/MediaFile"}},"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"}}}},"Domain":{"description":"Described the industry sector or sub-sector. The network policy should contain codes for all the industry sectors supported by the network. Domains can be created in varying levels of granularity. The granularity of a domain can be decided by the participants of the network. Too broad domains will result in irrelevant search broadcast calls to BPPs that don't have services supporting the domain. Too narrow domains will result in a large number of registry entries for each BPP. It is recommended that network facilitators actively collaborate with various working groups and network participants to carefully choose domain codes keeping in mind relevance, performance, and opportunity cost. It is recommended that networks choose broad domains like mobility, logistics, healthcare etc, and progressively granularize them as and when the number of network participants for each domain grows large.","type":"object","additionalProperties":false,"properties":{"name":{"description":"Name of the domain","type":"string"},"code":{"description":"Standard code representing the domain. The standard is usually published as part of the network policy. Furthermore, the network facilitator should also provide a mechanism to provide the supported domains of a network."},"additional_info":{"description":"A url that contains addtional information about that domain.","allOf":[{"$ref":"#/components/schemas/MediaFile"}]}}},"Duration":{"description":"Describes duration as per ISO8601 format","type":"string"},"Error":{"description":"Describes an error object that is returned by a BAP, BPP or BG as a response or callback to an action by another network participant. This object is sent when any request received by a network participant is unacceptable. This object can be sent either during Ack or with the callback.","type":"object","additionalProperties":false,"properties":{"code":{"type":"string","description":"Standard error code. For full list of error codes, refer to docs/protocol-drafts/BECKN-005-ERROR-CODES-DRAFT-01.md of this repo\""},"paths":{"type":"string","description":"Path to json schema generating the error. Used only during json schema validation errors"},"message":{"type":"string","description":"Human readable message describing the error. Used mainly for logging. Not recommended to be shown to the user."}}},"Fee":{"description":"A fee applied on a particular entity","type":"object","additionalProperties":false,"properties":{"percentage":{"description":"Percentage of a value","allOf":[{"$ref":"#/components/schemas/DecimalValue"}]},"amount":{"description":"A fixed value","allOf":[{"$ref":"#/components/schemas/Price"}]}}},"Form":{"description":"Describes a form","type":"object","additionalProperties":false,"properties":{"id":{"description":"The form identifier.","type":"string"},"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.","type":"string","format":"uri"},"data":{"description":"The form submission data","type":"object","additionalProperties":true},"mime_type":{"description":"This field indicates the nature and format of the form received by querying the url. MIME types are defined and standardized in IETF's RFC 6838.","type":"string","enum":["text/html","application/html","application/xml","none"]},"resubmit":{"type":"boolean"},"multiple_submissions":{"type":"boolean"}}},"Fulfillment":{"description":"Describes how a an order will be rendered/fulfilled to the end-customer","type":"object","additionalProperties":false,"properties":{"id":{"description":"Unique reference ID to the fulfillment of an order","type":"string"},"type":{"description":"A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. For example, a retail order can be fulfilled either via store pickup or a home delivery. Similarly, a medical consultation can be provided either in-person or via tele-consultation. The network policy must publish standard fulfillment type codes for the different modes of fulfillment.","type":"string"},"rateable":{"description":"Whether the fulfillment can be rated or not","type":"boolean"},"rating":{"description":"The rating value of the fulfullment service.","allOf":[{"$ref":"#/components/schemas/Rating/properties/value"}]},"state":{"description":"The current state of fulfillment. The BPP must set this value whenever the state of the order fulfillment changes and fire an unsolicited `on_status` call.","allOf":[{"$ref":"#/components/schemas/FulfillmentState"}]},"tracking":{"type":"boolean","description":"Indicates whether the fulfillment allows tracking","default":false},"customer":{"description":"The person that will ultimately receive the order","allOf":[{"$ref":"#/components/schemas/Customer"}]},"agent":{"description":"The agent that is currently handling the fulfillment of the order","allOf":[{"$ref":"#/components/schemas/Agent"}]},"contact":{"$ref":"#/components/schemas/Contact"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"stops":{"description":"The list of logical stops encountered during the fulfillment of an order.","type":"array","items":{"$ref":"#/components/schemas/Stop"}},"path":{"description":"The physical path taken by the agent that can be rendered on a map. The allowed format of this property can be set by the network.","type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"FulfillmentState":{"description":"Describes the state of fulfillment","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string","description":"ID of entity which changed the state"}}},"Gps":{"description":"Describes a GPS coordinate","type":"string","pattern":"^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?),\\s*[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$"},"Image":{"description":"Describes an image","type":"object","additionalProperties":false,"properties":{"url":{"description":"URL to the image. This can be a data url or an remote url","type":"string","format":"uri"},"size_type":{"description":"The size of the image. The network policy can define the default dimensions of each type","type":"string","enum":["xs","sm","md","lg","xl","custom"]},"width":{"description":"Width of the image in pixels","type":"string"},"height":{"description":"Height of the image in pixels","type":"string"}}},"Intent":{"description":"The intent to buy or avail a product or a service. The BAP can declare the intent of the consumer containing
  • What they want (A product, service, offer)
  • Who they want (A seller, service provider, agent etc)
  • Where they want it and where they want it from
  • When they want it (start and end time of fulfillment
  • How they want to pay for it

This has properties like descriptor,provider,fulfillment,payment,category,offer,item,tags
This is typically used by the BAP to send the purpose of the user's search to the BPP. This will be used by the BPP to find products or services it offers that may match the user's intent.
For example, in Mobility, the mobility consumer declares a mobility intent. In this case, the mobility consumer declares information that describes various aspects of their journey like,
  • Where would they like to begin their journey (intent.fulfillment.start.location)
  • Where would they like to end their journey (intent.fulfillment.end.location)
  • When would they like to begin their journey (intent.fulfillment.start.time)
  • When would they like to end their journey (intent.fulfillment.end.time)
  • Who is the transport service provider they would like to avail services from (intent.provider)
  • Who is traveling (This is not recommended in public networks) (intent.fulfillment.customer)
  • What kind of fare product would they like to purchase (intent.item)
  • What add-on services would they like to avail
  • What offers would they like to apply on their booking (intent.offer)
  • What category of services would they like to avail (intent.category)
  • What additional luggage are they carrying
  • How would they like to pay for their journey (intent.payment)

For example, in health domain, a consumer declares the intent for a lab booking the describes various aspects of their booking like,
  • Where would they like to get their scan/test done (intent.fulfillment.start.location)
  • When would they like to get their scan/test done (intent.fulfillment.start.time)
  • When would they like to get the results of their test/scan (intent.fulfillment.end.time)
  • Who is the service provider they would like to avail services from (intent.provider)
  • Who is getting the test/scan (intent.fulfillment.customer)
  • What kind of test/scan would they like to purchase (intent.item)
  • What category of services would they like to avail (intent.category)
  • How would they like to pay for their journey (intent.payment)
","type":"object","additionalProperties":false,"properties":{"descriptor":{"description":"A raw description of the search intent. Free text search strings, raw audio, etc can be sent in this object.","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"provider":{"description":"The provider from which the customer wants to place to the order from","allOf":[{"$ref":"#/components/schemas/Provider"}]},"fulfillment":{"description":"Details on how the customer wants their order fulfilled","allOf":[{"$ref":"#/components/schemas/Fulfillment"}]},"payment":{"description":"Details on how the customer wants to pay for the order","allOf":[{"$ref":"#/components/schemas/Payment"}]},"category":{"description":"Details on the item category","allOf":[{"$ref":"#/components/schemas/Category"}]},"offer":{"description":"details on the offer the customer wants to avail","allOf":[{"$ref":"#/components/schemas/Offer"}]},"item":{"description":"Details of the item that the consumer wants to order","allOf":[{"$ref":"#/components/schemas/Item"}]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"ItemQuantity":{"description":"Describes the count or amount of an item","type":"object","additionalProperties":false,"properties":{"allocated":{"description":"This represents the exact quantity allocated for purchase of the item.","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"measure":{"$ref":"#/components/schemas/Scalar"}}},"available":{"description":"This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"measure":{"$ref":"#/components/schemas/Scalar"}}},"maximum":{"description":"This represents the maximum quantity allowed for purchase of the item","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":1},"measure":{"$ref":"#/components/schemas/Scalar"}}},"minimum":{"description":"This represents the minimum quantity allowed for purchase of the item","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"measure":{"$ref":"#/components/schemas/Scalar"}}},"selected":{"description":"This represents the quantity selected for purchase of the item","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"measure":{"$ref":"#/components/schemas/Scalar"}}},"unitized":{"description":"This represents the quantity available in a single unit of the item","type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":1,"maximum":1},"measure":{"$ref":"#/components/schemas/Scalar"}}}}},"Item":{"description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.","type":"object","additionalProperties":false,"properties":{"id":{"description":"ID of the item.","type":"string"},"parent_item_id":{"description":"ID of the item, this item is a variant of","allOf":[{"$ref":"#/components/schemas/Item/properties/id"}]},"parent_item_quantity":{"description":"The number of units of the parent item this item is a multiple of","allOf":[{"$ref":"#/components/schemas/ItemQuantity"}]},"descriptor":{"description":"Physical description of the item","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"creator":{"description":"The creator of this item","allOf":[{"$ref":"#/components/schemas/Organization"}]},"price":{"description":"The price of this item, if it has intrinsic value","allOf":[{"$ref":"#/components/schemas/Price"}]},"quantity":{"description":"The selling quantity of the item","allOf":[{"$ref":"#/components/schemas/ItemQuantity"}]},"margin":{"description":"The selling margin of the item","allOf":[{"$ref":"#/components/schemas/ItemQuantity"}]},"category_ids":{"description":"Categories this item can be listed under","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Category/properties/id"}]}},"fulfillment_ids":{"description":"Modes through which this item can be fulfilled","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Fulfillment/properties/id"}]}},"location_ids":{"description":"Provider Locations this item is available in","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Location/properties/id"}]}},"payment_ids":{"description":"Payment modalities through which this item can be ordered","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Payment/properties/id"}]}},"add_ons":{"type":"array","items":{"$ref":"#/components/schemas/AddOn"}},"cancellation_terms":{"description":"Cancellation terms of this item","type":"array","items":{"$ref":"#/components/schemas/CancellationTerm"}},"refund_terms":{"description":"Refund terms of this item","type":"array","items":{"description":"Refund term of an item or an order","type":"object","additionalProperties":false,"properties":{"fulfillment_state":{"description":"The state of fulfillment during which this term is applicable.","allOf":[{"$ref":"#/components/schemas/State"}]},"refund_eligible":{"description":"Indicates if cancellation will result in a refund","type":"boolean"},"refund_within":{"description":"Time within which refund will be processed after successful cancellation.","allOf":[{"$ref":"#/components/schemas/Time"}]},"refund_amount":{"$ref":"#/components/schemas/Price"}}}},"replacement_terms":{"description":"Terms that are applicable be met when this item is replaced","type":"array","items":{"$ref":"#/components/schemas/ReplacementTerm"}},"return_terms":{"description":"Terms that are applicable when this item is returned","type":"array","items":{"$ref":"#/components/schemas/ReturnTerm"}},"xinput":{"description":"Additional input required from the customer to purchase / avail this item","allOf":[{"$ref":"#/components/schemas/XInput"}]},"time":{"description":"Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.","allOf":[{"$ref":"#/components/schemas/Time"}]},"rateable":{"description":"Whether this item can be rated","type":"boolean"},"rating":{"description":"The rating of the item","allOf":[{"$ref":"#/components/schemas/Rating/properties/value"}]},"matched":{"description":"Whether this item is an exact match of the request","type":"boolean"},"related":{"description":"Whether this item is a related item to the exactly matched item","type":"boolean"},"recommended":{"description":"Whether this item is a recommended item to a response","type":"boolean"},"ttl":{"description":"Time to live in seconds for an instance of this schema","type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}},"creds":{"type":"array","items":{"$ref":"#/components/schemas/Credential"}}}},"Location":{"description":"The physical location of something","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"map_url":{"description":"The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.","type":"string","format":"uri"},"gps":{"description":"The GPS co-ordinates of this location.","allOf":[{"$ref":"#/components/schemas/Gps"}]},"updated_at":{"type":"string","format":"date-time"},"address":{"description":"The address of this location.","allOf":[{"$ref":"#/components/schemas/Address"}]},"city":{"description":"The city this location is, or is located within","allOf":[{"$ref":"#/components/schemas/City"}]},"district":{"description":"The state this location is, or is located within","type":"string"},"state":{"description":"The state this location is, or is located within","allOf":[{"$ref":"#/components/schemas/State"}]},"country":{"description":"The country this location is, or is located within","allOf":[{"$ref":"#/components/schemas/Country"}]},"area_code":{"type":"string"},"circle":{"$ref":"#/components/schemas/Circle"},"polygon":{"description":"The boundary polygon of this location","type":"string"},"3dspace":{"description":"The three dimensional region describing this location","type":"string"},"rating":{"description":"The rating of this location","allOf":[{"$ref":"#/components/schemas/Rating/properties/value"}]},"time":{"description":"Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Time"}]}}}},"MediaFile":{"description":"This object contains a url to a media file.","type":"object","additionalProperties":false,"properties":{"mimetype":{"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":{"description":"The URL of the file","type":"string","format":"uri"},"signature":{"description":"The digital signature of the file signed by the sender","type":"string"},"dsa":{"description":"The signing algorithm used by the sender","type":"string"}}},"Offer":{"description":"An offer associated with a catalog. This is typically used to promote a particular product and enable more purchases.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"location_ids":{"type":"array","items":{"$ref":"#/components/schemas/Location/properties/id"}},"category_ids":{"type":"array","items":{"$ref":"#/components/schemas/Category/properties/id"}},"item_ids":{"type":"array","items":{"$ref":"#/components/schemas/Item/properties/id"}},"time":{"$ref":"#/components/schemas/Time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"Option":{"description":"Describes a selectable option","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"descriptor":{"$ref":"#/components/schemas/Descriptor"}}},"Order":{"description":"Describes a legal purchase order. It contains the complete details of the legal contract created between the buyer and the seller.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Human-readable ID of the order. This is generated at the BPP layer. The BPP can either generate order id within its system or forward the order ID created at the provider level."},"ref_order_ids":{"description":"A list of order IDs to link this order to previous orders.","type":"array","items":{"type":"string","description":"ID of a previous order"}},"status":{"description":"Status of the order. Allowed values can be defined by the network policy","type":"string","enum":["ACTIVE","COMPLETE","CANCELLED","COMPLETED","SOFT_CANCEL","CANCELLATION_INITIATED","CANCELLATION_REJECTED","SOFT_UPDATE","CONFIRM_UPDATE","UPDATED"]},"type":{"description":"This is used to indicate the type of order being created to BPPs. Sometimes orders can be linked to previous orders, like a replacement order in a retail domain. A follow-up consultation in healthcare domain. A single order part of a subscription order. The list of order types can be standardized at the network level.","type":"string","default":"DEFAULT","enum":["DRAFT","DEFAULT"]},"provider":{"description":"Details of the provider whose catalog items have been selected.","allOf":[{"$ref":"#/components/schemas/Provider"}]},"items":{"description":"The items purchased / availed in this order","type":"array","items":{"$ref":"#/components/schemas/Item"}},"add_ons":{"description":"The add-ons purchased / availed in this order","type":"array","items":{"$ref":"#/components/schemas/AddOn"}},"offers":{"description":"The offers applied in this order","type":"array","items":{"$ref":"#/components/schemas/Offer"}},"billing":{"description":"The billing details of this order","allOf":[{"$ref":"#/components/schemas/Billing"}]},"fulfillments":{"description":"The fulfillments involved in completing this order","type":"array","items":{"$ref":"#/components/schemas/Fulfillment"}},"cancellation":{"description":"The cancellation details of this order","allOf":[{"$ref":"#/components/schemas/Cancellation"}]},"cancellation_terms":{"description":"Cancellation terms of this item","type":"array","items":{"$ref":"#/components/schemas/CancellationTerm"}},"documents":{"type":"array","items":{"description":"Documnents associated to the order","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"mime_type":{"description":"This field indicates the nature and format of the form received by querying the url. MIME types are defined and standardized in IETF's RFC 6838.","type":"string","enum":["text/html","application/html","application/xml","application/pdf"]},"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.","type":"string","format":"uri"}}}},"refund_terms":{"description":"Refund terms of this item","type":"array","items":{"$ref":"#/components/schemas/Item/properties/refund_terms/items"}},"replacement_terms":{"description":"Replacement terms of this item","type":"array","items":{"$ref":"#/components/schemas/ReplacementTerm"}},"return_terms":{"description":"Return terms of this item","type":"array","items":{"$ref":"#/components/schemas/ReturnTerm"}},"quote":{"description":"The mutually agreed upon quotation for this order.","allOf":[{"$ref":"#/components/schemas/Quotation"}]},"payments":{"description":"The terms of settlement for this order","type":"array","items":{"$ref":"#/components/schemas/Payment"}},"created_at":{"description":"The date-time of creation of this order","type":"string","format":"date-time"},"updated_at":{"description":"The date-time of updated of this order","type":"string","format":"date-time"},"xinput":{"description":"Additional input required from the customer to confirm this order","allOf":[{"$ref":"#/components/schemas/XInput"}]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"Organization":{"description":"An organization. Usually a recognized business entity.","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"address":{"description":"The postal address of the organization","allOf":[{"$ref":"#/components/schemas/Address"}]},"state":{"description":"The state where the organization's address is registered","allOf":[{"$ref":"#/components/schemas/State"}]},"city":{"description":"The city where the the organization's address is registered","allOf":[{"$ref":"#/components/schemas/City"}]},"contact":{"$ref":"#/components/schemas/Contact"}}},"Payment":{"description":"Describes the terms of settlement between the BAP and the BPP for a single transaction. When instantiated, this object contains
  1. the amount that has to be settled,
  2. The payment destination destination details
  3. When the settlement should happen, and
  4. A transaction reference ID
. During a transaction, the BPP reserves the right to decide the terms of payment. However, the BAP can send its terms to the BPP first. If the BPP does not agree to those terms, it must overwrite the terms and return them to the BAP. If overridden, the BAP must either agree to the terms sent by the BPP in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the BAP and the BPP can perform offline negotiations on the payment terms. Once an agreement is reached, the BAP and BPP can resume transactions.","type":"object","additionalProperties":false,"properties":{"id":{"description":"ID of the payment term that can be referred at an item or an order level in a catalog","type":"string"},"collected_by":{"description":"This field indicates who is the collector of payment. The BAP can set this value to 'bap' if it wants to collect the payment first and settle it to the BPP. If the BPP agrees to those terms, the BPP should not send the payment url. Alternatively, the BPP can set this field with the value 'bpp' if it wants the payment to be made directly.","type":"string"},"url":{"type":"string","description":"A payment url to be called by the BAP. If empty, then the payment is to be done offline. The details of payment should be present in the params object. If tl_method = http/get, then the payment details will be sent as url params. Two url param values, ```$transaction_id``` and ```$amount``` are mandatory.","format":"uri"},"tl_method":{"type":"string"},"params":{"type":"object","additionalProperties":false,"properties":{"transaction_id":{"type":"string","description":"The reference transaction ID associated with a payment activity"},"amount":{"type":"string"},"currency":{"type":"string"},"bank_code":{"type":"string"},"bank_account_number":{"type":"string"},"virtual_payment_address":{"type":"string"},"source_bank_code":{"type":"string"},"source_bank_account_number":{"type":"string"},"source_virtual_payment_address":{"type":"string"}}},"type":{"type":"string","enum":["PRE_ORDER","PRE_FULFILLMENT","ON_FULFILLMENT","POST_FULFILLMENT","ON_ORDER","PART_PAYMENT","ON_CANCELLATION","POST_CANCELLATION"]},"status":{"type":"string","enum":["PAID","NOT_PAID"]},"time":{"$ref":"#/components/schemas/Time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}}}},"Person":{"description":"Describes a person as any individual","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Describes the identity of the person"},"url":{"description":"Profile url of the person","type":"string","format":"uri"},"name":{"description":"the name of the person","type":"string"},"image":{"$ref":"#/components/schemas/Image"},"age":{"description":"Age of the person","allOf":[{"$ref":"#/components/schemas/Duration"}]},"dob":{"description":"Date of birth of the person","type":"string","format":"date"},"gender":{"type":"string","description":"Gender of something, typically a Person, but possibly also fictional characters, animals, etc. While Male and Female may be used, text strings are also acceptable for people who do not identify as a binary gender.Allowed values for this field can be published in the network policy"},"creds":{"type":"array","items":{"$ref":"#/components/schemas/Credential"}},"languages":{"type":"array","items":{"description":"Describes a language known to the person.","type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"name":{"type":"string"}}}},"skills":{"type":"array","items":{"description":"Describes a skill of the person.","type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"name":{"type":"string"}}}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}},"descriptor":{"$ref":"#/components/schemas/Descriptor"}}},"Price":{"description":"Describes the price of a product or service","type":"object","additionalProperties":false,"properties":{"currency":{"type":"string"},"value":{"$ref":"#/components/schemas/DecimalValue"},"estimated_value":{"$ref":"#/components/schemas/DecimalValue"},"computed_value":{"$ref":"#/components/schemas/DecimalValue"},"listed_value":{"$ref":"#/components/schemas/DecimalValue"},"offered_value":{"$ref":"#/components/schemas/DecimalValue"},"minimum_value":{"$ref":"#/components/schemas/DecimalValue"},"maximum_value":{"$ref":"#/components/schemas/DecimalValue"}}},"Provider":{"description":"Describes the catalog of a business.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Id of the provider"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"category_id":{"type":"string","description":"Category Id of the provider at the BPP-level catalog"},"rating":{"$ref":"#/components/schemas/Rating/properties/value"},"time":{"$ref":"#/components/schemas/Time"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"fulfillments":{"type":"array","items":{"$ref":"#/components/schemas/Fulfillment"}},"payments":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"}},"offers":{"type":"array","items":{"$ref":"#/components/schemas/Offer"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"exp":{"type":"string","description":"Time after which catalog has to be refreshed","format":"date-time"},"rateable":{"description":"Whether this provider can be rated or not","type":"boolean"},"ttl":{"description":"The time-to-live in seconds, for this object. This can be overriden at deeper levels. A value of -1 indicates that this object is not cacheable.","type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagGroup"}},"cancellation_terms":{"description":"Cancellation terms of this item","type":"array","items":{"$ref":"#/components/schemas/CancellationTerm"}}}},"Quotation":{"description":"Describes a quote. It is the estimated price of products or services from the BPP.
This has properties like price, breakup, ttl","type":"object","additionalProperties":false,"properties":{"id":{"description":"ID of the quote.","type":"string"},"price":{"description":"The total quoted price","allOf":[{"$ref":"#/components/schemas/Price"}]},"breakup":{"description":"the breakup of the total quoted price","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"item":{"$ref":"#/components/schemas/Item"},"title":{"type":"string"},"price":{"$ref":"#/components/schemas/Price"}}}},"ttl":{"$ref":"#/components/schemas/Duration"}}},"Rating":{"description":"Describes the rating of an entity","type":"object","additionalProperties":false,"properties":{"rating_category":{"description":"Category of the entity being rated","type":"string","enum":["ITEM","ORDER","FULFILLMENT","PROVIDER","AGENT","SUPPORT"]},"id":{"description":"Id of the object being rated","type":"string"},"value":{"description":"Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.","type":"string"}}},"Region":{"description":"Describes an arbitrary region of space. The network policy should contain a published list of supported regions by the network.","type":"object","additionalProperties":false,"properties":{"dimensions":{"description":"The number of dimensions that are used to describe any point inside that region. The most common dimensionality of a region is 2, that represents an area on a map. There are regions on the map that can be approximated to one-dimensional regions like roads, railway lines, or shipping lines. 3 dimensional regions are rarer, but are gaining popularity as flying drones are being adopted for various fulfillment services.","type":"string","enum":["1","2","3"]},"type":{"description":"The type of region. This is used to specify the granularity of the region represented by this object. Various examples of two-dimensional region types are city, country, state, district, and so on. The network policy should contain a list of all possible region types supported by the network.","type":"string"},"name":{"type":"string","description":"Name of the region as specified on the map where that region exists."},"code":{"type":"string","description":"A standard code representing the region. This should be interpreted in the same way by all network participants."},"boundary":{"type":"string","description":"A string representing the boundary of the region. One-dimensional regions are represented by polylines. Two-dimensional regions are represented by polygons, and three-dimensional regions can represented by polyhedra."},"map_url":{"type":"string","description":"The url to the map of the region. This can be a globally recognized map or the one specified by the network policy."}}},"ReplacementTerm":{"description":"The replacement policy of an item or an order","type":"object","additionalProperties":false,"properties":{"fulfillment_state":{"description":"The state of fulfillment during which this term is applicable.","allOf":[{"$ref":"#/components/schemas/State"}]},"replace_within":{"description":"Applicable only for buyer managed returns where the buyer has to replace the item before a certain date-time, failing which they will not be eligible for replacement","allOf":[{"$ref":"#/components/schemas/Time"}]},"external_ref":{"$ref":"#/components/schemas/MediaFile"}}},"ReturnTerm":{"description":"Describes the return policy of an item or an order","type":"object","additionalProperties":false,"properties":{"fulfillment_state":{"description":"The state of fulfillment during which this term IETF''s applicable.","allOf":[{"$ref":"#/components/schemas/State"}]},"return_eligible":{"description":"Indicates whether the item is eligible for return","type":"boolean"},"return_time":{"description":"Applicable only for buyer managed returns where the buyer has to return the item to the origin before a certain date-time, failing which they will not be eligible for refund.","allOf":[{"$ref":"#/components/schemas/Time"}]},"return_location":{"description":"The location where the item or order must / will be returned to","allOf":[{"$ref":"#/components/schemas/Location"}]},"fulfillment_managed_by":{"description":"The entity that will perform the return","type":"string","enum":["CONSUMER","PROVIDER"]}}},"Scalar":{"description":"Describes a scalar","type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["CONSTANT","VARIABLE"]},"value":{"$ref":"#/components/schemas/DecimalValue"},"estimated_value":{"$ref":"#/components/schemas/DecimalValue"},"computed_value":{"$ref":"#/components/schemas/DecimalValue"},"range":{"type":"object","additionalProperties":false,"properties":{"min":{"$ref":"#/components/schemas/DecimalValue"},"max":{"$ref":"#/components/schemas/DecimalValue"}}},"unit":{"type":"string"}}},"Schedule":{"description":"Describes schedule as a repeating time period used to describe a regularly recurring event. At a minimum a schedule will specify frequency which describes the interval between occurrences of the event. Additional information can be provided to specify the schedule more precisely. This includes identifying the timestamps(s) of when the event will take place. Schedules may also have holidays to exclude a specific day from the schedule.
This has properties like frequency, holidays, times","type":"object","additionalProperties":false,"properties":{"frequency":{"$ref":"#/components/schemas/Duration"},"holidays":{"type":"array","items":{"type":"string","format":"date-time"}},"times":{"type":"array","items":{"type":"string","format":"date-time"}}}},"State":{"description":"A bounded geopolitical region of governance inside a country.","type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the state"},"code":{"type":"string","description":"State code as per country or international standards"}}},"Stop":{"description":"A logical point in space and time during the fulfillment of an order.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"parent_stop_id":{"type":"string"},"location":{"description":"Location of the stop","allOf":[{"$ref":"#/components/schemas/Location"}]},"type":{"description":"The type of stop. Allowed values of this property can be defined by the network policy.","type":"string"},"time":{"description":"Timings applicable at the stop.","allOf":[{"$ref":"#/components/schemas/Time"}]},"instructions":{"description":"Instructions that need to be followed at the stop","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"contact":{"description":"Contact details of the stop","allOf":[{"$ref":"#/components/schemas/Contact"}]},"person":{"description":"The details of the person present at the stop","allOf":[{"$ref":"#/components/schemas/Person"}]},"authorization":{"$ref":"#/components/schemas/Authorization"}}},"Support":{"description":"Details of customer support","type":"object","additionalProperties":false,"properties":{"ref_id":{"type":"string"},"callback_phone":{"type":"string","format":"phone"},"phone":{"type":"string","format":"phone"},"email":{"type":"string","format":"email"},"url":{"type":"string","format":"uri"},"descriptor":{"$ref":"#/components/schemas/Descriptor"},"ref_type":{"type":"string"}}},"Tag":{"description":"Describes a tag. This is used to contain extended metadata. This object can be added as a property to any schema to describe extended attributes. For BAPs, tags can be sent during search to optimize and filter search results. BPPs can use tags to index their catalog to allow better search functionality. Tags are sent by the BPP as part of the catalog response in the `on_search` callback. Tags are also meant for display purposes. Upon receiving a tag, BAPs are meant to render them as name-value pairs. This is particularly useful when rendering tabular information about a product or service.","type":"object","additionalProperties":false,"properties":{"descriptor":{"description":"Description of the Tag, can be used to store detailed information.","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"value":{"description":"The value of the tag. This set by the BPP and rendered as-is by the BAP.","type":"string"},"display":{"description":"This value indicates if the tag is intended for display purposes. If set to `true`, then this tag must be displayed. If it is set to `false`, it should not be displayed. This value can override the group display value.","type":"boolean"}}},"TagGroup":{"description":"A collection of tag objects with group level attributes. For detailed documentation on the Tags and Tag Groups schema go to https://github.com/beckn/protocol-specifications/discussions/316","type":"object","additionalProperties":false,"properties":{"display":{"description":"Indicates the display properties of the tag group. If display is set to false, then the group will not be displayed. If it is set to true, it should be displayed. However, group-level display properties can be overriden by individual tag-level display property. As this schema is purely for catalog display purposes, it is not recommended to send this value during search.","type":"boolean","default":true},"descriptor":{"description":"Description of the TagGroup, can be used to store detailed information.","allOf":[{"$ref":"#/components/schemas/Descriptor"}]},"list":{"description":"An array of Tag objects listed under this group. This property can be set by BAPs during search to narrow the `search` and achieve more relevant results. When received during `on_search`, BAPs must render this list under the heading described by the `name` property of this schema.","type":"array","items":{"$ref":"#/components/schemas/Tag"}}}},"Time":{"description":"Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operations
This has properties like label, time stamp,duration,range, days, schedule","type":"object","additionalProperties":false,"properties":{"label":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"duration":{"$ref":"#/components/schemas/Duration"},"range":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"days":{"type":"string","description":"comma separated values representing days of the week"},"schedule":{"$ref":"#/components/schemas/Schedule"}}},"Tracking":{"description":"Contains tracking information that can be used by the BAP to track the fulfillment of an order in real-time. which is useful for knowing the location of time sensitive deliveries.","type":"object","additionalProperties":false,"properties":{"id":{"description":"A unique tracking reference number","type":"string"},"url":{"description":"A URL to the tracking endpoint. This can be a link to a tracking webpage, a webhook URL created by the BAP where BPP can push the tracking data, or a GET url creaed by the BPP which the BAP can poll to get the tracking data. It can also be a websocket URL where the BPP can push real-time tracking data.","type":"string","format":"uri"},"location":{"description":"In case there is no real-time tracking endpoint available, this field will contain the latest location of the entity being tracked. The BPP will update this value everytime the BAP calls the track API.","allOf":[{"$ref":"#/components/schemas/Location"}]},"status":{"description":"This value indicates if the tracking is currently active or not. If this value is `active`, then the BAP can begin tracking the order. If this value is `inactive`, the tracking URL is considered to be expired and the BAP should stop tracking the order.","type":"string","enum":["active","inactive"]}}},"Vehicle":{"description":"Describes a vehicle is a device that is designed or used to transport people or cargo over land, water, air, or through space.
This has properties like category, capacity, make, model, size,variant,color,energy_type,registration","type":"object","additionalProperties":false,"properties":{"category":{"type":"string"},"capacity":{"type":"integer"},"make":{"type":"string"},"model":{"type":"string"},"size":{"type":"string"},"variant":{"type":"string"},"color":{"type":"string"},"energy_type":{"type":"string"},"registration":{"type":"string"},"wheels_count":{"type":"string"},"cargo_volumne":{"type":"string"},"wheelchair_access":{"type":"string"},"code":{"type":"string"},"emission_standard":{"type":"string"}}},"XInput":{"description":"Contains any additional or extended inputs required to confirm an order. This is typically a Form Input. Sometimes, selection of catalog elements is not enough for the BPP to confirm an order. For example, to confirm a flight ticket, the airline requires details of the passengers along with information on baggage, identity, in addition to the class of ticket. Similarly, a logistics company may require details on the nature of shipment in order to confirm the shipping. A recruiting firm may require additional details on the applicant in order to confirm a job application. For all such purposes, the BPP can choose to send this object attached to any object in the catalog that is required to be sent while placing the order. This object can typically be sent at an item level or at the order level. The item level XInput will override the Order level XInput as it indicates a special requirement of information for that particular item. Hence the BAP must render a separate form for the Item and another form at the Order level before confirmation.","type":"object","additionalProperties":false,"properties":{"head":{"description":"Provides the header information for the xinput.","type":"object","additionalProperties":false,"properties":{"descriptor":{"$ref":"#/components/schemas/Descriptor"},"index":{"type":"object","additionalProperties":false,"properties":{"min":{"type":"integer"},"cur":{"type":"integer"},"max":{"type":"integer"}}},"headings":{"type":"array","items":{"type":"string","description":"The heading names of the forms"}}}},"form":{"$ref":"#/components/schemas/Form"},"form_response":{"description":"Describes the response to a form submission","type":"object","additionalProperties":false,"properties":{"status":{"description":"Contains the status of form submission.","type":"string"},"signature":{"type":"string"},"submission_id":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}},"required":{"description":"Indicates whether the form data is mandatorily required by the BPP to confirm the order.","type":"boolean"}}}}},"x-enum":{"search":{"context":{"action":[{"code":"search","description":"Buyer app indicates the search intent","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"intent":{"category":{"descriptor":{"code":[{"code":"ON_DEMAND_TRIP","description":"Describes the category of the on_demand offer","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"catalog":{"providers":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]}},"on_status":{"context":{"action":[{"code":"on_status","description":"Seller app return order with status , Driver pickup - driver drop","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}]}}}}},"cancel":{"context":{"action":[{"code":"cancel","description":"Buyer app requests order cancellation.\"","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"cancellation_reason_id":[{"code":"000","description":"Technical cancellation of orders in case protocol technical failures(BAP/BPP)","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""},{"code":"PROVIDER","description":"Describes, when the ride is cancelled by the provider.","reference":""}],"reason":{"descriptor":{"code":[{"code":"000","description":"Technical cancellation of orders in case protocol technical failures(BAP/BPP)","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"order":{"items":{"descriptor":{"code":[{"code":"RIDE","description":"Describes the type of ride.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]}},"on_track":{"context":{"action":[{"code":"on_track","description":"Seller app specifies the on_track.","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]}},"support":{"context":{"action":[{"code":"support","description":"Buyer app requests order support.\"","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"support":{"descriptor":{"code":[{"code":"SOS","description":"Describes the support code value as SOS","reference":""},{"code":"LONG_HALT","description":"Describes the support code value as LONG_HALT","reference":""},{"code":"ROUTE_DEV","description":"Describes the support code value as ROUTE_DEV","reference":""}]}}}},"on_support":{"context":{"action":[{"code":"on_support","description":"Buyer app requests order support.\"","reference":""}],"location":{"country":{"code":[{"code":"IND","description":"Represents the country","reference":""}]},"city":{"code":[{"code":"std:080","description":"Bangalore","reference":""}]}},"domain":[{"code":"ONDC:TRV10","description":"mobility domain Ride","reference":""}]},"message":{"support":{"descriptor":{"code":[{"code":"SOS","description":"Describes the support code value as SOS","reference":""},{"code":"LONG_HALT","description":"Describes the support code value as LONG_HALT","reference":""},{"code":"ROUTE_DEV","description":"Describes the support code value as ROUTE_DEV","reference":""}]}}}}},"x-tags":{"search":{"message":{"intent":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"item":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]}]}}}},"on_search":{"message":{"catalog":{"tags":[{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"providers":{"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]}}}}},"on_select":{"message":{"order":{"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"init":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}]}}},"on_init":{"message":{"order":{"tags":[{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"confirm":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"on_confirm":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"on_status":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"on_cancel":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}},"on_update":{"message":{"order":{"tags":[{"code":"BAP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]},{"code":"BPP_TERMS","description":"Describes the finder fees for buyer","reference":"","list":[{"code":"STATIC_TERMS","description":"Terms for settlement","reference":""},{"code":"OFFLINE_CONTRACT","description":"Indicates whether the contractual agreement between the buyer and the seller is executed outside the ONDC protocol. Values can be true or false","reference":""}]}],"items":{"tags":[{"code":"DISABILITY_VIS","description":"Describes the Vision Impairment","reference":"","list":[{"code":"VIS_LEVEL","description":"Describes the Level of Disability","reference":"","list":[{"code":"LOW","description":"Describes the Level of Disability","reference":""},{"code":"TOTAL","description":"Describes the Level of Disability","reference":""}]},{"code":"VIS_SCREEN_READER_USAGE","description":"Describes the Screen Reader Usage","reference":"","list":[{"code":"JAWS","description":"Describes the Screen Reader Usage","reference":""},{"code":"NVDA","description":"Describes the Screen Reader Usage","reference":""},{"code":"OTHERS","description":"Describes the Screen Reader Usage","reference":""}]},{"code":"VIS_CANE_USAGE","description":"Describes the Cane Usag","reference":"","list":[{"code":"YES","description":"Describes the Cane Usag","reference":""},{"code":"NO","description":"Describes the Cane Usag","reference":""},{"code":"SOMETIMES","description":"Describes the Cane Usag","reference":""}]},{"code":"VIS_SPECIAL_REQUIREMENT","description":"Describes the custom text entered by user","reference":""}]},{"code":"DISABILITY_HEA","description":"Describes the Hearing Impairment","reference":"","list":[{"code":"HEA_READING_ABILITY","description":"Describes the Reading Ability","reference":"","list":[{"code":"FULL","description":"Describes the Reading Ability","reference":""},{"code":"PARTIAL","description":"Describes the Reading Ability","reference":""},{"code":"NO","description":"Describes the Reading Ability","reference":""}]},{"code":"HEA_SIGN_LANGUAGE_PREFERENCE","description":"Describes the sign Language Preference","reference":"","list":[{"code":"ASL","description":"Describes the sign Language Preference","reference":""},{"code":"BSL","description":"Describes the sign Language Preference","reference":""},{"code":"OTHERS","description":"Describes the sign Language Preference","reference":""}]},{"code":"HEA_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MOB","description":"Describes the Disability of movement","reference":"","list":[{"code":"MOB_DISABILITY","description":"Describes the mob disability","reference":"","list":[{"code":"LOCOMOTOR","description":"Describes the mob disability","reference":""},{"code":"MULTIPLE_SCLEROSIS","description":"Describes the mob disability","reference":""},{"code":"CEREBRAL_PALSY","description":"Describes the mob disability","reference":""},{"code":"MUSCULAR_DYSTROPHY","description":"Describes the mob disability","reference":""},{"code":"OTHERS","description":"Describes the mob disability","reference":""}]},{"code":"MOB_WHEELCHAIR_USAGE","description":"Describes the wheelchair usage","reference":"","list":[{"code":"YES","description":"Describes the wheelchair usage","reference":""},{"code":"NO","description":"Describes the wheelchair usage","reference":""},{"code":"SOMETIMES","description":"Describes the wheelchair usage","reference":""}]},{"code":"MOB_CRUTCHES_USAGE","description":"Describes the crutches usage","reference":"","list":[{"code":"YES","description":"Describes the crutches usage","reference":""},{"code":"NO","description":"Describes the crutches usage","reference":""},{"code":"SOMETIMES","description":"Describes the crutches usage","reference":""}]},{"code":"MOB_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_LEP","description":"Describes the Leprosy Cured","reference":"","list":[{"code":"LEP_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_SPE","description":"Describes the Speech and Language Disability","reference":"","list":[{"code":"SPE_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_INTEL","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"INTEL_DISABILITY","description":"Describes the Intellectual Disability","reference":"","list":[{"code":"AUTISM_SPECTRUM_DISORDER","description":"Describes the Intellectual Disability","reference":""},{"code":"SPECIFIC_LEARNING_DISABILITIES","description":"Describes the Intellectual Disability","reference":""},{"code":"PARKINSON","description":"Describes the Intellectual Disability","reference":""},{"code":"OTHERS","description":"Describes the Intellectual Disability","reference":""}]},{"code":"INTEL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"MENTAL","description":"Describes the Mental Illness","reference":"","list":[{"code":"MENTAL_DISABILITY","description":"Describes the Mental Disability","reference":"","list":[{"code":"SCHIZOPHRENIA","description":"Describes the Mental Disability","reference":""},{"code":"BIPOLAR_DISORDER","description":"Describes the Mental Disability","reference":""},{"code":"DEPRESSION","description":"Describes the Mental Disability","reference":""},{"code":"OTHERS","description":"Describes the Mental Disability","reference":""}]},{"code":"MENTAL_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_BLOOD","description":"Describes the Blood Related Disorders","reference":"","list":[{"code":"BLOOD_DISABILITY","description":"Describes the blood Disability","reference":"","list":[{"code":"HEMOPHILIA","description":"Describes the blood Disability","reference":""},{"code":"THALASSEMIA","description":"Describes the blood Disability","reference":""},{"code":"SICKLE_CELL_ANEMIA","description":"Describes the blood Disability","reference":""},{"code":"OTHERS","description":"Describes the blood Disability","reference":""}]},{"code":"BLOOD_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_DWARFISM","description":"Describes the Dwarfism","reference":"","list":[{"code":"DWARFISM_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_ACID_ATTACK_SURVIVOR","description":"Describes the Acid Attack Survivor","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"DISABILITY_MULTIPLE_DIS","description":"Describes the Multiple Disabilities","reference":"","list":[{"code":"ACID_ATTACK_SURVIVOR_SPECIAL_REQUIREMENT","description":"Describes the special requirement","reference":""}]},{"code":"FARE_POLICY","description":"Details about fare for the ride","reference":"","list":[{"code":"MIN_FARE","description":"Describes the minimum fare","reference":""},{"code":"MIN_FARE_DISTANCE_KM","description":"Describes the minimum fare per KM","reference":""},{"code":"PER_KM_CHARGE","description":"Describes the per km charge","reference":""},{"code":"PICKUP_CHARGE","description":"Describes the pickup charge","reference":""},{"code":"WAITING_CHARGE_PER_MIN","description":"Describes the waiting charge per minute","reference":""},{"code":"NIGHT_CHARGE_MULTIPLIER","description":"Describes the times need to multiply for night charge","reference":""},{"code":"NIGHT_SHIFT_START_TIME","description":"Describes the time when night shift starts","reference":""},{"code":"NIGHT_SHIFT_END_TIME","description":"Describes the time when night shift ends","reference":""},{"code":"DEAD_KM_FARE","description":"Describes the dead kilometer fare","reference":""},{"code":"FREE_WAIT_TIME_PERIOD","description":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location.","reference":""}]},{"code":"INFO","description":"Describes the general info about the ride","reference":"","list":[{"code":"DISTANCE_TO_NEAREST_DRIVER_METER","description":"Describes the distance to nearest driver.","reference":""},{"code":"ETA_TO_NEAREST_DRIVER_MIN","description":"Describes the ETA to nearest driver.","reference":""}]}]},"fulfillments":{"tags":[{"code":"ROUTE_INFO","description":"Describes the route information.","reference":"","list":[{"code":"ENCODED_POLYLINE","description":"Describes the encoded polyline value.","reference":""},{"code":"WAYPOINTS","description":"Describes the waypoints value.","reference":""}]}]}}}}},"x-flows":[{"summary":"On-Demand - Assign driver on on-confirm","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"payment_ids":["PA1","PA2"],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"id":"PA1","type":"ON_FULFILLMENT","collected_by":"BPP","status":"NOT_PAID"},{"id":"PA2","type":"POST_CANCELLATION","status":"NOT_PAID","collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver on on-confirm (Add Ons)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"available":{"count":1},"maximum":{"count":1}}}],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"available":{"count":1},"maximum":{"count":1}}}],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"he Buyer App selects a specific service and may optionally choose add-ons","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":1}}}]}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":1}}}]}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":1}}}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"add_ons":[{"id":"A1","descriptor":{"name":"Ride Insurance"},"price":{"currency":"INR","value":"100"},"quantity":{"selected":{"count":1}}}],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"100"},"item":{"id":"A1"},"title":"ADD_ONS"}],"price":{"currency":"INR","value":"246"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver on on-confirm(BAP Collecting)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[BAP Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BAP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[BAP Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[BAP Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BAP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[BAP Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app provides the payment update to Seller app","api":"update","details":[{"description":"Buyer app provides the payment update to Seller app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Buyer app provides the payment update to Seller app","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"47e05cc2-2bc4-41c9-81fb-26be6ae74403","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.payments","order":{"id":"01","payments":[{"collected_by":"BAP","id":"PA1","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"},"status":"PAID","type":"ON_FULFILLMENT"}]}}}}},{"summary":"Seller app provides the latest order status with updated payment details","api":"on_update","details":[{"description":"Seller app provides the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n \n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Seller app provides the latest order status","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver on on-confirm(BAP Collecting, On-Order)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[BAP Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BAP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[BAP Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[BAP Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BAP","status":"NOT_PAID","type":"PRE_ORDER"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[BAP Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"PRE_ORDER"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver on on-confirm(BAP Collecting, Quote-Update)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[BAP Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BAP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[BAP Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[BAP Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BAP","status":"NOT_PAID","type":"PRE_ORDER"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[BAP Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","type":"PRE_ORDER"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride with updated fare details (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}},{"collected_by":"BAP","id":"PA2","status":"NOT_PAID","type":"POST_FULFILLMENT","params":{"amount":"10","currency":"INR"}}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app provides the payment update to Seller app","api":"update","details":[{"description":"Buyer app provides the payment update to Seller app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Buyer app provides the payment update to Seller app","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"47e05cc2-2bc4-41c9-81fb-26be6ae74403","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.payments","order":{"id":"01","payments":[{"collected_by":"BAP","id":"PA2","params":{"amount":"10","currency":"INR","transaction_id":"3cb81b36-5997-4fa9-9b5f-5b0b1ae25001"},"status":"PAID","type":"POST_FULFILLMENT"}]}}}}},{"summary":"Seller app provides the latest order status with updated payment details","api":"on_update","details":[{"description":"Seller app provides the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n \n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Seller app provides the latest order status","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"PAID","type":"PRE_ORDER","params":{"amount":"146","currency":"INR","transaction_id":"204d672e-4def-463c-a0d4-d7b24ecbae45"}},{"collected_by":"BAP","id":"PA2","params":{"amount":"10","currency":"INR","transaction_id":"3cb81b36-5997-4fa9-9b5f-5b0b1ae25001"},"status":"PAID","type":"POST_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Assign driver post on-confirm","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"payment_ids":["PA1","PA2"],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"id":"PA1","type":"ON_FULFILLMENT","collected_by":"BPP","status":"NOT_PAID"},{"id":"PA2","type":"POST_CANCELLATION","status":"NOT_PAID","collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:48:34.53Z","tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the latest update on ride details to the buyer app.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy"}},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Assign driver post on-confirm(Self-Pickup)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"On Demand"}}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"payments":[{"collected_by":"BPP"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}]}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}]}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the latest update on ride details to the buyer app.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_status","details":[{"description":"Ride provider provides the latest update on ride details to the buyer app with fulfillment state - RIDE_STARTED","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"PAID","type":"ON_FULFILLMENT","params":{"amount":"146"}}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Female Driver Flow","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"customer":{"person":{"gender":"FEMALE"}},"agent":{"person":{"gender":"FEMALE"}},"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}},{"id":"F3","customer":{"person":{"gender":"FEMALE"}},"agent":{"person":{"gender":"FEMALE"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"CAB Economy Ride – Female Driver"},"category_ids":["C1"],"fulfillment_ids":["F3"],"id":"I3","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"matched":true,"recommended":false},{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"matched":false,"recommended":true},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"matched":false,"recommended":true}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Ride cancellation by driver","details":[{"description":"Detailed process of cancelling a ride with soft & confirm status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel (unsolicited)\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK "}],"steps":[{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel (unsolicited)\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider accepts the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel (unsolicited)\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end "}],"reference":"if any","example":{"summary":"Return current order status after confirm-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"0"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"0"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"PROVIDER","reason":{"descriptor":{"code":"013"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Ride cancellation by rider","details":[{"description":"Detailed process of cancelling a ride with soft & confirm status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app cancels the request for ride","api":"cancel","details":[{"description":"Buyer app requests for cancellation of ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with soft cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts/appends the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after soft-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the cancel request for ride","api":"cancel","details":[{"description":"Buyer app give the confirmation to cancel the ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with confirm cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"CONFIRM_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after confirm-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"ACTIVE","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Technical Cancellation Flow","details":[{"description":"Detailed process of cancelling a ride with soft & confirm status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): NACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK \n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK "}],"reference":"if any","steps":[{"summary":"Provider confirms the request","api":"on_confirm","details":[{"description":"The provider has confirmed the request, but the buyer app received the request after the TTL had expired.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): NACK \n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK "}],"reference":"if any","example":{"value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app request for latest order status","api":"status","details":[{"description":"Buyer app request for latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): NACK \n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK "}],"reference":"if any","example":{"value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"ref_id":"870782be-6757-43f1-945c-8eeaf9536259"}}}},{"summary":"Provider sends the latest order status","api":"on_status","details":[{"description":"Provider sends the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): NACK \n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app cancels the request for ride(Optional)","api":"cancel","details":[{"description":"Buyer app requests for cancellation of ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8bbe4998-6243-4ce6-9859-c0f21c06d3db","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"000"}}},"descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Provider accepts/appends the terms of cancellation(Optional)","api":"on_cancel","details":[{"description":"Provider accepts the terms of order and appends its own terms and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"000"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the cancel request for ride","api":"cancel","details":[{"description":"Buyer app give the confirmation to cancel the ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8bbe4998-6243-4ce6-9859-c0f21c06d3db","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"000"}}},"descriptor":{"code":"CONFIRM_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Provider accepts the terms of cancellation","api":"on_cancel","details":[{"description":"Provider accepts the terms of order and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end "}],"reference":"if any","example":{"value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"000"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"Driver not found on on_confirm","references":"if any","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","reference":"if any","api":"on_confirm","example":{"value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"error":{"code":"90203","message":"Driver not assigned to the order"}}},"details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}]}]},{"summary":"Driver not found post on_confirm","references":"if any","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","reference":"if any","api":"on_confirm","example":{"value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:48:34.53Z","tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},"details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}]},{"summary":"Ride not found after on_confirm","reference":"if any","api":"on_cancel","example":{"value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"PROVIDER","reason":{"descriptor":{"code":"011"}}},"created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},"details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}]}]},{"summary":"On-Demand - Ride with multiple stops","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816","address":"XYZ, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END","id":"3","parent_stop_id":"2"}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","category_ids":["C1"],"location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","category_ids":["C1"],"location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","category_ids":["C1"],"location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Update Stop","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app requests for update of stop","api":"update","details":[{"description":"Buyer app request the provider platform to update the stop","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With fulfillment id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Update an active ride","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.fulfillments","order":{"id":"01","status":"SOFT_UPDATE","fulfillments":[{"id":"F1","stops":[{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}]}]}}}}},{"summary":"Provider platform confirms with on_update request","api":"on_update","details":[{"description":"Provider platform provides the updated order details","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"SOFT_UPDATE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for update of stop","api":"update","details":[{"description":"Buyer app request the provider platform to update the stop","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With fulfillment id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Update an active ride","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"47e05cc2-2bc4-41c9-81fb-26be6ae74403","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.fulfillments","order":{"id":"01","status":"CONFIRM_UPDATE","fulfillments":[{"id":"F1","stops":[{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}]}]}}}}},{"summary":"Provider platform confirms with on_update request","api":"on_update","details":[{"description":"Provider platform provides the updated order details","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"UPDATED","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Provider platform provide the latest order status","api":"on_status","details":[{"description":"Provider platform provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Pre Order Bid","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"payment_ids":["PA1","PA2"],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"id":"PA1","type":"ON_FULFILLMENT","collected_by":"BPP","status":"NOT_PAID"},{"id":"PA2","type":"POST_CANCELLATION","status":"NOT_PAID","collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","price":{"currency":"INR","value":"166"}}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"166"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"20"},"title":"BUYER_ADDITIONAL_AMOUNT"}],"price":{"currency":"INR","value":"166"},"ttl":"PT30S"}}}}}}]},{"summary":"On-Demand - Post Order Tip","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for update of quote (tipping)","api":"update","details":[{"description":"Buyer app requests for update of quote (tipping)","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With order id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated quote\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Update an active ride","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.quote.breakup","order":{"id":"O1","quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"20"},"title":"BUYER_ADDITIONAL_AMOUNT"}],"price":{"currency":"INR","value":"166"}}}}}}},{"summary":"Provider platform confirms with on_update request","api":"on_update","details":[{"description":"Provider platform provides the updated order details","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update quote\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated quote\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"PT60M"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"Delivery"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"DELAY_INTEREST"},"value":"2.5"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"1.46"},{"descriptor":{"code":"SETTLEMENT_BANK_CODE"},"value":"XXXXXXXX"},{"descriptor":{"code":"SETTLEMENT_BANK_ACCOUNT_NUMBER"},"value":"xxxxxxxxxxxxxx"},{"descriptor":{"code":"SETTLEMENT_VIRTUAL_PAYMENT_ADDRESS"},"value":"9988199772@okicic"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"20"},"title":"BUYER_ADDITIONAL_AMOUNT"}],"price":{"currency":"INR","value":"166"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Rental","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_RENTAL"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"circle":{"gps":"13.008935, 77.644408","radius":{"type":"CONSTANT","value":"100","unit":"KILOMETER"}}},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"category_ids":["C3"],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C3"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"add_ons":[{"id":"A2","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"1","unit":"HOURS"}}},"descriptor":{"name":"time","code":"TIME"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C3","descriptor":{"code":"ON_DEMAND_RENTAL","name":"Rental"}}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","category_ids":["C3"],"location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C3"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"Schedule - Rental","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"SCHEDULED_RENTAL"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C4"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"add_ons":[{"id":"A2","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"1","unit":"HOURS"}}},"descriptor":{"name":"time","code":"TIME"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C4","descriptor":{"code":"SCHEDULED_RENTAL","name":"Rental"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides the agent details","api":"on_update","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"4ce7055d-2511-4586-b18f-b50822048447","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACKs\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C4"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"3"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"30"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"title":"ADD_ONS","item":{"id":"I1","add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"selected":{"count":3}}}]},"price":{"currency":"INR","value":"60"}}],"price":{"currency":"INR","value":"206"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"Schedule - Trip","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title schedule Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"SCHEDULED_TRIP"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"}}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"}},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C2"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C2","descriptor":{"code":"SCHEDULED_TRIP","name":"scheduled"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service for more details","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides the agent details","api":"on_update","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n \n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START","time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"UNCLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"time":{"timestamp":"2024-11-07T00:32:19.000Z"}},{"location":{"gps":"12.971186, 77.586812"},"authorization":{"token":"144254","type":"OTP","valid_to":"2023-12-15T08:05:34.294Z","status":"CLAIMED"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C2"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Rental(when end stop gps coordinate is present)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_RENTAL"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"category_ids":["C3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"add_ons":[{"id":"A1","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"10","unit":"KILOMETERS"}}},"descriptor":{"name":"distance","code":"DISTANCE"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C3"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"add_ons":[{"id":"A2","price":{"currency":"INR","value":"20"},"quantity":{"allocated":{"count":1},"maximum":{"count":10},"minimum":{"count":1},"unitized":{"measure":{"value":"1","unit":"HOURS"}}},"descriptor":{"name":"time","code":"TIME"}}],"tags":[{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"TOTAL_HOURS"},"value":"1"},{"descriptor":{"code":"TOTAL_DISTANCE"},"value":"10"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C3","descriptor":{"code":"ON_DEMAND_RENTAL","name":"Rental"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"No Acceptance - Soft_Cancel","details":[{"description":"Detailed process of No Acceptance flow atter soft_cancel.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app cancels the request for ride","api":"cancel","details":[{"description":"Buyer app requests for cancellation of ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with soft cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts/appends the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return current order status after soft-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider sends unsolicited on_status call","api":"on_status","details":[{"description":"The ride provider sends an unsolicited on_status call and reverted to the original order state as no response was received from the buyer app within the defined TTL.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after soft-cancel","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"975ff507-439e-4933-acf4-4aaed4af0d51","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"No Acceptance - Soft_Update","details":[{"description":"Detailed process of No Acceptance flow atter soft_update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With fulfillment id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app requests for update of stop","api":"update","details":[{"description":"Buyer app request the provider platform to update the stop","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - With fulfillment id\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Update an active ride","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.fulfillments","order":{"id":"01","status":"SOFT_UPDATE","fulfillments":[{"id":"F1","stops":[{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}]}]}}}}},{"summary":"Provider platform confirms with on_update request","api":"on_update","details":[{"description":"Provider platform provides the updated order details","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.968540, 77.564459"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"SOFT_UPDATE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider sends unsolicited on_status call","api":"on_status","details":[{"description":"The ride provider sends an unsolicited on_status call and reverted to the original order state as no response was received from the buyer app within the defined TTL.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update - update stops\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update - Provide updated stops\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"a6ef2152-7cec-4560-b0ec-04fb13691813","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"id":"1"},{"location":{"gps":"12.981224, 77.615816"},"type":"INTERMEDIATE_STOP","id":"2","parent_stop_id":"1"},{"location":{"gps":"12.971186, 77.586812"},"type":"END","id":"3","parent_stop_id":"2"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"156"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"126"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"156"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"BPP Collecting - Payment Confirmation","details":[{"description":"The illustrative flow depicts the comprehensive process of payment confirmation, showcasing the sequential steps and interactions involved in a payment transaction.","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP) ->> Buyer Platform (BAP) : form"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Buyer Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP) ->> Buyer Platform (BAP) : form"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Buyer Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app redirects to payment gateway page.","api":"form","details":[{"description":"Buyer app redirects to payment gateway page using the link provided in the previous step.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP) ->> Buyer Platform (BAP) : form\n end"}],"reference":"if any","example":{"value":"This will redirected to different html page"}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"ref_id":"870782be-6757-43f1-945c-8eeaf9536259"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Buyer Collecting]","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c","amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"}}}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"9a7be37d-f228-432b-9aa9-65144d48da38","timestamp":"2023-12-10T04:34:49.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"9a7be37d-f228-432b-9aa9-65144d48da38","timestamp":"2023-12-10T04:34:52.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c","amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T04:34:52.031Z","updated_at":"2023-12-10T04:34:52.031Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Purple Tags (Assign driver on on-confirm)","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Buyer app search for available ride providers","api":"search","details":[{"description":"Buyer app explore ride providers to avail a mobility service from Location A to Location B (GPS) over the network.","mermaid":"sequenceDiagram\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Search for mobility services by pickup and drop location[Seller Collecting]","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"eb60e750-2b11-4170-8bd3-b4c6370835d9","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Get a list of all services from ride providers","api":"on_search","details":[{"description":"Ride providers which is a mobility provider platform sends the catalog of all services that can be used for transit from A to B along with estimated fare & list of supported purple tags.","mermaid":"sequenceDiagram\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return a mobility catalog[Seller Collecting]","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"eb60e750-2b11-4170-8bd3-b4c6370835d9","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"category_ids":["C5"],"tags":[{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"}},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"}},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"}},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"}}]},{"descriptor":{"name":"Dwarfism","code":"DISABILITY_DWARFISM"},"display":false,"list":[{"descriptor":{"code":"DWARFISM_SPECIAL_REQUIREMENT","name":"Dwarfism","short_desc":"Custom description"}}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C5"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BPP"}],"categories":[{"id":"C5","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app selects a specific service & select specific purple tags.","api":"select","details":[{"description":"The buyer app has selected a specific service and would like to obtain a quotation for that service.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get quote for a specific product from a mobility catalog","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"01c1903c-f943-4c11-8e93-dff5ce3c30bd","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","tags":[{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider provides the quote for selected service","api":"on_select","details":[{"description":"Ride provider responds with detailed information and quote for the specific service that the buyer app would like to avail.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return a quote offered by a provider","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"01c1903c-f943-4c11-8e93-dff5ce3c30bd","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"category_ids":["C5"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}},{"summary":"Buyer app initializes the ride request","api":"init","details":[{"description":"Buyer app platform shares the terms of order and initializes the request.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initialize draft order and request for terms of service[Seller Collecting]","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}}},{"summary":"Ride provider accepts/appends the terms of orders","api":"on_init","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and responds with the final draft.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return draft order with payment terms[Seller Collecting]","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"category_ids":["C5"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the ride","api":"confirm","details":[{"description":"Buyer app confirms the booking and provides all the required information for confirmation as per the terms of the order.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Confirm ride booking","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}] "}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"category_ids":["C5"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Buyer app requests for tracking status","api":"track","details":[{"description":"Buyer app request the provider platform to provide with latest tracking status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Track an active ride","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Provider platform provides latest order tracking status","api":"on_track","details":[{"description":"Provider platform provides the updated order tracking status to the consumer","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): track - Request tracking status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_track - Provide tracking status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end"}],"reference":"if any","example":{"summary":"Return tracking information for an order","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"Ride provider provides latest update on the ride (unsolicited call)","api":"on_update","details":[{"description":"Ride provider provides the updated order updates to the buyer app & can update the quote in case of fare update","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return updated order with recomputed charges","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}},{"summary":"Buyer app seeks the most recent status update","api":"status","details":[{"description":"Buyer app requests the ride provider to provide the latest order status","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Get latest fulfillment status of a booking","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return order with status - Driver at pickup","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C5"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"name":"Vision Impairment","code":"DISABILITY_VIS"},"display":false,"list":[{"descriptor":{"code":"VIS_LEVEL","name":"Level of Disability","short_desc":"Disability of Blind and low vision"},"value":"LOW"},{"descriptor":{"code":"VIS_SCREEN_READER_USAGE","name":"Screen Reader Usage","short_desc":"Screen Reader Usage"},"value":"JAWS"},{"descriptor":{"code":"VIS_CANE_USAGE","name":"Cane Usage","short_desc":"Cane Usage"},"value":"Yes"},{"descriptor":{"code":"VIS_SPECIAL_REQUIREMENT","name":"special requirement","short_desc":"Custom description"},"value":"CUSTOM TEXT ENTERED BY USER"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}}}]},{"summary":"On-Demand - Ride cancellation by rider(BAP Collecting)","details":[{"description":"Detailed process of cancelling a ride with soft & confirm status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n end\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n Buyer Platform (BAP)->>Seller Platform (BPP): status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app cancels the request for ride","api":"cancel","details":[{"description":"Buyer app requests for cancellation of ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with soft cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts/appends the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and appends its own terms and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK \n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with soft_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after soft-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"},{"collected_by":"BAP","id":"PA2","status":"NOT_PAID","type":"POST_CANCELLATION"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app confirms the cancel request for ride","api":"cancel","details":[{"description":"Buyer app give the confirmation to cancel the ride.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Initiates cancelling a ride with confirm cancel status","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"CONFIRM_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}},{"summary":"Ride provider accepts the terms of cancellation","api":"on_cancel","details":[{"description":"Ride provider accepts the terms of order and provides with latest order update.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): cancel - with confirm_cancel request\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_cancel\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return current order status after confirm-cancel","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"},{"collected_by":"BAP","id":"PA2","status":"NOT_PAID","type":"POST_CANCELLATION"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"ACTIVE","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Buyer app shares the updated payment status with Seller app.","api":"update","details":[{"description":"Buyer app shares the updated payment status with Seller app.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP):on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Buyer app shares the updated payment status with Seller app.","value":{"context":{"action":"update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"396a3c9a-838d-46cd-8fd9-311b93cdb2d0","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"update_target":"order.payments","order":{"id":"01","payments":[{"collected_by":"BAP","id":"PA2","params":{"amount":"10","currency":"INR","transaction_id":"ed8bebf6-1ed8-48d0-8506-e0bc35d93d60"},"status":"PAID","type":"POST_CANCELLATION"}]}}}}},{"summary":"Seller app shares the updated order status.","api":"on_update","details":[{"description":"Seller app shares the updated order status.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): update\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_update\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Seller app shares the updated order status.","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"396a3c9a-838d-46cd-8fd9-311b93cdb2d0","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1","PA2"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"},{"collected_by":"BAP","id":"PA2","params":{"amount":"10","currency":"INR","transaction_id":"ed8bebf6-1ed8-48d0-8506-e0bc35d93d60"},"status":"PAID","type":"POST_CANCELLATION"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}}]},{"summary":"On-Demand - Support","details":[{"description":"The illustraive flow to perform a transaction of the nature where in a buyer would like to book a mobility service form location A(gps-cordinates) to localtion B(gps-cordinates)","mermaid":"sequenceDiagram\n title On-Demand Discovery\n Buyer Platform (BAP)->>Gateway (BG): search\n Gateway (BG) ->> Buyer Platform (BAP): ACK\n Gateway (BG)->>Registry: Lookup Seller Platforms (lookup)\n Registry->>Gateway (BG): List of Seller Platforms (200 OK)\n Gateway (BG)->>Seller Platform (BPP): search\n Seller Platform (BPP)->>Gateway (BG) : ACK\n Seller Platform (BPP)->>Buyer Platform (BAP): Publish Catalog of Seller 1 (on_search)\n Buyer Platform (BAP)->>Seller Platform (BPP): ACK"},{"description":"Ordering","mermaid":"sequenceDiagram\n title Selection\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): select\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_select\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Initializing the order","mermaid":"sequenceDiagram\n title Initializing Order\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): init\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_init\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Order Confirmation","mermaid":"sequenceDiagram\n title Order Confirmation\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"},{"description":"Fulfillment","mermaid":"sequenceDiagram\n title Order Fulfillment\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): status-Request application status\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_status - Provide application status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"steps":[{"summary":"Ride provider confirms the ride request","api":"on_confirm","details":[{"description":"Ride provider confirms the ride request and provides the ride details on confirmation.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK"}],"reference":"if any","example":{"summary":"Return confirmed order with latest fulfillment details","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Buyer Platform (BAP)->>Seller Platform (BPP): confirm\n Seller Platform (BPP)-->>Buyer Platform (BAP):ACK\n Seller Platform (BPP)->>Buyer Platform (BAP):on_confirm\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}}},{"summary":"Ride provider provides latest order status","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}},{"summary":"Ride provider provides latest order updates","api":"on_status","details":[{"description":"Ride provider provides the updated order status to the buyer app","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_status\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end"}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}}},{"summary":"The Buyer App initiates the support request","api":"support","details":[{"description":"The Buyer App initiates the support request","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): support\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n Seller Platform (BPP)->>Buyer Platform (BAP): on_support\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"support","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"396a3c9a-838d-46cd-8fd9-311b93cdb2d0","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"support":{"descriptor":{"code":"SOS","name":"sos emergency","short_desc":"Driver has deviated from the planned route."},"ref_type":"ORDER","ref_id":"O1"}}}}},{"summary":"The Seller App returns the on_support response to the Buyer App.","api":"on_support","details":[{"description":"The Seller App returns the on_support response to the Buyer App.","mermaid":"sequenceDiagram\n participant Buyer Platform (BAP)\n participant Seller Platform (BPP)\n Seller Platform (BPP)->>Buyer Platform (BAP): support\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n rect rgb(191, 223, 255)\n Seller Platform (BPP)->>Buyer Platform (BAP): on_support\n Buyer Platform (BAP)-->>Seller Platform (BPP): ACK\n end\n "}],"reference":"if any","example":{"summary":"Return updated order with updated agent details","value":{"context":{"action":"on_support","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"396a3c9a-838d-46cd-8fd9-311b93cdb2d0","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"support":{"descriptor":{"code":"SOS","name":"sos emergency","short_desc":"Driver has deviated from the planned route."},"ref_type":"ORDER","ref_id":"O1","email":"support@example-bpp.com","phone":"+918068870525","url":"https://example-bpp.com/prod/seller/gethelp"}}}}}]}],"x-examples":{"on-demand":{"summary":"On Demand Use Case Specification","description":"The On-demand use case on the network would enable NPs to perform on-demand ride hailing related transactions on the network. These APIs are utilized by consumer and provider platforms enabling every consumer/ end-user on all consumer platforms to consume the services/ inventory provided by all provider platforms on the network seamlessly. Consumer platforms shall use these specifications to perform transaction operations like discovery, selection, booking, status check and others so as to purchase services/ inventory on the network eg: autos, cabs etc. Provider Platform shall use these specifications to expose their services/ inventory in form of autos or cabs rides. Gateway specifications are used to broadcast demands originating from a consumer platform to all applicable provider platforms in a transparent and unbiased manner.","example_set":{"cancel":{"examples":[{"summary":"Initiates_cancelling_a_ride_with_confirm_cancel_status___X5","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"CONFIRM_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}},{"summary":"Initiates_cancelling_a_ride_with_soft_cancel_status___X4","value":{"context":{"action":"cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"be6a495a-e941-4fbf-9d59-f1e6166cccc8","timestamp":"2023-03-23T05:15:08Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"cancellation":{"reason":{"descriptor":{"code":"002"}}},"descriptor":{"code":"SOFT_CANCEL","name":"Ride Cancellation"},"order_id":"O1"}}}]},"confirm":{"examples":[{"summary":"Confirm_ride_booking___X6","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"confirm_buyer_app_confirms_the_booking_and_provides_all_the_required_information_for_confirmation_as_per_the_terms_of_the_order__5","description":"TBD","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"6743e9e2-4fb5-487c-92b7-13ba8018f176","timestamp":"2023-12-10T04:34:48.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"confirm_buyer_app_confirms_the_booking_and_provides_all_the_required_information_for_confirmation_as_per_the_terms_of_the_order__6","description":"TBD","value":{"context":{"action":"confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"9a7be37d-f228-432b-9aa9-65144d48da38","timestamp":"2023-12-10T04:34:49.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"init":{"examples":[{"summary":"Initialize_draft_order_and_request_for_terms_of_service[Seller_Collecting]___X7","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"}}}}},{"summary":"init_buyer_app_platform_shares_the_terms_of_order_and_initializes_the_request__1","description":"TBD","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"init_buyer_app_platform_shares_the_terms_of_order_and_initializes_the_request__3","description":"TBD","value":{"context":{"action":"init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:09:31.307Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"name":"Joe Adams"},"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"id":"I1"}],"payments":[{"collected_by":"BPP","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"on_cancel":{"examples":[{"summary":"Return_current_order_status_after_confirm-cancel___X9","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:45.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"0"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"0"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"PROVIDER","reason":{"descriptor":{"code":"013"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:45.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"Return_current_order_status_after_soft-cancel___X8","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:44.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","version":"2.1.0","ttl":"PT30S"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"},{"price":{"currency":"INR","value":"10"},"title":"CANCELLATION_CHARGES"},{"price":{"currency":"INR","value":"-146"},"title":"REFUND"}],"price":{"currency":"INR","value":"10"},"ttl":"PT30S"},"status":"SOFT_CANCEL","cancellation":{"cancelled_by":"CONSUMER","reason":{"descriptor":{"code":"002"}}},"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"cancel_after_confirm","description":"TBD","value":{"context":{"action":"on_cancel","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CANCELLED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"CANCELLED","cancellation":{"cancelled_by":"PROVIDER","reason":{"descriptor":{"code":"011"}}},"created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"on_confirm":{"examples":[{"summary":"Return_confirmed_order_with_latest_fulfillment_details___X10","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"Return_confirmed_order_with_latest_fulfillment_details___X11","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:48:34.53Z","tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"Return_confirmed_order_with_latest_fulfillment_details___X12","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","params":{"amount":"146","currency":"INR","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259"},"status":"PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"DELAY_INTEREST"},"value":"5"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"P2D"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"DELIVERY"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"144.54"},{"descriptor":{"code":"SETTLEMENT_BANK_CODE"},"value":"XXXXXXXX"},{"descriptor":{"code":"SETTLEMENT_BANK_ACCOUNT_NUMBER"},"value":"xxxxxxxxxxxxxx"},{"descriptor":{"code":"SETTLEMENT_VIRTUAL_PAYMENT_ADDRESS"},"value":"9988199772@okicic"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}},{"summary":"on_confirm_ride_provider_confirms_the_ride_request_and_provides_the_ride_details_on_confirmation__6","description":"TBD","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_CONFIRMED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_confirm_ride_provider_confirms_the_ride_request_and_provides_the_ride_details_on_confirmation__7","description":"TBD","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"9a7be37d-f228-432b-9aa9-65144d48da38","timestamp":"2023-12-10T04:34:52.031Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c","amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T04:34:52.031Z","updated_at":"2023-12-10T04:34:52.031Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"ride_cancelled","description":"TBD","value":{"context":{"action":"on_confirm","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"error":{"code":"90203","message":"Driver not assigned to the order"}}}]},"on_init":{"examples":[{"summary":"Return_draft_order_with_payment_terms[Seller_Collecting]___X13","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_init_ride_provider_accepts_the_terms_of_order_and_appends_its_own_terms_and_responds_with_the_final_draft__2","description":"TBD","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_init_ride_provider_accepts_the_terms_of_order_and_appends_its_own_terms_and_responds_with_the_final_draft__4","description":"TBD","value":{"context":{"action":"on_init","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T14:11:32.859Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}]}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"on_rating":{"examples":[{"summary":"Return_acknowledgement_of_rating_and_feedback___X14","value":{"context":{"action":"on_rating","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"2a17e268-1dc4-4d1a-98a2-17554a50c7d2","timestamp":"2023-03-23T05:41:15Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"feedback_ack":true,"rating_ack":true}}}]},"on_search":{"examples":[{"summary":"Return_a_mobility_catalog[Buyer_Collecting]___X16","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"collected_by":"BAP"}]}],"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"DELAY_INTEREST"},"value":"5"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"}]}]}}}},{"summary":"Return_a_mobility_catalog[Seller_Collecting]___X15","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."},"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"SEDAN","energy_type":"PETROL"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"payment_ids":["PA1","PA2"],"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"tags":[{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"AC"},{"value":"LOW_PRICE"},{"value":"FREE_WIFI"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"payments":[{"id":"PA1","type":"ON_FULFILLMENT","collected_by":"BPP","status":"NOT_PAID"},{"id":"PA2","type":"POST_CANCELLATION","status":"NOT_PAID","collected_by":"BAP"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"on demand"}}]}],"tags":[{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_search_ride_providers_which_is_a_mobility_provider_platform_sends_the_catalog_of_all_services_that_can_be_used_for_transit_from_a_to_b_along_with_estimated_fare__1","description":"TBD","value":{"context":{"action":"on_search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"21e54d3c-9c3b-47c1-aa3b-b0e7b20818ee","timestamp":"2023-12-09T13:41:16.161Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"catalog":{"tags":[{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"descriptor":{"name":"Mobility Servies BPP"},"providers":[{"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}},{"id":"F2","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"CAB","variant":"SEDAN"}}],"id":"P1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","maximum_value":"176","minimum_value":"136","value":"146"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]},{"descriptor":{"code":"RIDE","name":"CAB Economy Ride"},"category_ids":["C1"],"fulfillment_ids":["F2"],"id":"I2","location_ids":["L2","L4"],"price":{"currency":"INR","maximum_value":"236","minimum_value":"206","value":"206"},"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"90"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}]}],"locations":[{"gps":"12.916468,77.608998","id":"L1"},{"gps":"12.916714,77.609298","id":"L2"},{"gps":"12.916573,77.615216","id":"L3"},{"gps":"12.906857,77.604456","id":"L4"}],"categories":[{"id":"C1","descriptor":{"code":"ON_DEMAND_TRIP","name":"On Demand"}}],"cancellation_terms":[{"cancellation_fee":{"percentage":"10"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"external_ref":{"url":"https://example-bpp.com/prod/seller/v1/cancellation_terms.pdf","mimetype":"application/pdf"}}],"payments":[{"collected_by":"BPP"}]}]}}}}]},"on_select":{"examples":[{"summary":"Return_a_quote_offered_by_a_provider___X17","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}},{"summary":"on_select_ride_provider_responds_with_detailed_information_and_quote_for_the_specific_service_that_the_buyer_app_would_like_to_avail__2","description":"TBD","value":{"context":{"action":"on_select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-09T13:49:26.132Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}]}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}}]},"on_status":{"examples":[{"summary":"Return_order_with_latest_fulfillment_status_-_Driver_en-route_to_pickup___X19","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP","name":"Driver is en-route to your location"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"PT60M"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"Delivery"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"DELAY_INTEREST"},"value":"2.5"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"174"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}},{"summary":"Return_order_with_latest_status_-_Ride_Ended___X21","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"CAB","variant":"AUTO_RICKSHAW","make":"Mahindra","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","status":"NOT_PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"PT60M"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"Delivery"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"DELAY_INTEREST"},"value":"2.5"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"174"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}},{"summary":"Return_order_with_latest_status_-_Ride_started___X20","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED","name":"Your ride has started"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BAP","id":"PA1","params":{"bank_account_number":"xxxxxxxxxxxxxx","bank_code":"XXXXXXXX","virtual_payment_address":"9988199772@okicic"},"status":"NOT_PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"PT60M"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"Delivery"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"DELAY_INTEREST"},"value":"2.5"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"174"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"}}}}},{"summary":"Return_order_with_status_-_Driver_at_pickup___X18","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_status_ride_provider_provides_the_latest_update_on_ride_details_to_the_buyer_app_with_fulfillment_state___ride_started_8","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_1","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"5ee2001f-e612-431d-9e07-49574af60e88","timestamp":"2023-12-10T08:03:35.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z"}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_10","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"fulfillment_ids":["F1"],"category_ids":["C1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"PAID","type":"ON_FULFILLMENT","params":{"amount":"146"}}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_2","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_3","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_STARTED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_4","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"id":"O1","cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED","name":"Your ride has ended"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"COMPLETED","documents":[{"descriptor":{"code":"INVOICE","name":"Invoice Document","short_desc":"Download your Invoice document here.","long_desc":"This document is password protected. To open it, enter your password in DDMMMYYYYXXXX format, where DDMMMYYYY represents your date of birth and XXXX represents the first four letters of your name."},"mime_type":"application/pdf","url":"https://example-bpp.com/prod/seller/invoices/O1.pdf"}],"created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_5","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:59Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"name":"BPP Terms of Engagement","code":"BPP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"stops":[{"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW"}}],"items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","params":{"transaction_id":"f08966dc-4c7d-4152-9a15-1046798cc39c","amount":"146"},"status":"PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"}}}}}},{"summary":"on_status_ride_provider_provides_the_updated_order_status_to_the_buyer_app_12","description":"TBD","value":{"context":{"action":"on_status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"94e0ac3d-7191-4a8b-b987-4f6fa79559cf","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"on_support":{"examples":[{"summary":"Return_support_information_related_to_an_order___X22","value":{"context":{"action":"on_support","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"support":{"email":"support@nammayatri.in","phone":"+918068870525","url":"https://support.nammayatri.com/gethelp"}}}}]},"on_track":{"examples":[{"summary":"Return_tracking_information_for_an_order___X23","value":{"context":{"action":"on_track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"ec3dea8c-c64c-4f06-b2a0-ec1f9584d7ba","timestamp":"2023-03-23T05:41:09Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"tracking":{"status":"active","location":{"gps":"28.620976, 77.046732","updated_at":"2023-03-23T05:41:09Z"}}}}}]},"on_update":{"examples":[{"summary":"Return_updated_order_with_recomputed_charges___X24","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-11T03:54:28.832Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"},"creds":[{"type":"MEMBERSHIP_TIER","id":"Verified"},{"type":"ACTIVE_SINCE","id":"P5Y"},{"type":"BADGES","id":"Tidy"},{"type":"ACHIEVEMENTS","id":"500 Five-Star Rides"},{"type":"TOTAL_NUMBER_OF_TRIPS","id":"1000"}]},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"FEATURE_LIST","name":"Feature list"},"list":[{"value":"NON_AC"},{"value":"LOW_PRICE"},{"value":"DOORSTEP_PICK_UP"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1","descriptor":{"images":[{"url":"https://example-bpp.com/prod/seller/assets/images/header/logo.png","size_type":"sm"}],"name":"Uber","short_desc":"Uber Rides","long_desc":"Uber Rides, India."}},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-11T03:54:28.832Z"}}}},{"summary":"Return_updated_order_with_updated_agent_details___X26","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:49:34.53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"tags":[{"descriptor":{"code":"BAP_TERMS","name":"BAP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:34.53Z","updated_at":"2023-03-23T04:49:34.53Z"}}}},{"summary":"Return_updated_order_with_updated_billing_details___X25","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"billing":{"email":"jane.doe@example.com","name":"Jane Doe","phone":"+91-9897867564"},"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP"},"location":{"gps":"13.008935, 77.644408"},"instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"},"type":"START"},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"DELIVERY","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","tags":[{"descriptor":{"code":"BUYER_FINDER_FEES"},"display":false,"list":[{"descriptor":{"code":"BUYER_FINDER_FEES_PERCENTAGE"},"value":"1"}]},{"descriptor":{"code":"SETTLEMENT_TERMS"},"display":false,"list":[{"descriptor":{"code":"DELAY_INTEREST"},"value":"5"},{"descriptor":{"code":"SETTLEMENT_TYPE"},"value":"UPI"},{"descriptor":{"code":"SETTLEMENT_WINDOW"},"value":"P2D"},{"descriptor":{"code":"SETTLEMENT_BASIS"},"value":"DELIVERY"},{"descriptor":{"code":"MANDATORY_ARBITRATION"},"value":"true"},{"descriptor":{"code":"COURT_JURISDICTION"},"value":"New Delhi"},{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bpp.com/static-terms.txt"},{"descriptor":{"code":"SETTLEMENT_AMOUNT"},"value":"1.46"},{"descriptor":{"code":"SETTLEMENT_BANK_CODE"},"value":"XXXXXXXX"},{"descriptor":{"code":"SETTLEMENT_BANK_ACCOUNT_NUMBER"},"value":"xxxxxxxxxxxxxx"},{"descriptor":{"code":"SETTLEMENT_VIRTUAL_PAYMENT_ADDRESS"},"value":"9988199772@okicic"}]}],"type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-03-23T04:48:53Z","updated_at":"2023-03-23T04:48:53Z"}}}},{"summary":"on_update_ride_provider_provides_the_latest_update_on_ride_details_to_the_buyer_app__7","description":"TBD","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"UNCLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}},{"summary":"on_update_ride_provider_provides_the_updated_order_updates_to_the_buyer_app___can_update_the_quote_in_case_of_fare_update_9","description":"TBD","value":{"context":{"action":"on_update","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-12-10T08:03:34.294Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order":{"cancellation_terms":[{"cancellation_fee":{"percentage":"0"},"fulfillment_state":{"descriptor":{"code":"RIDE_ASSIGNED"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"30"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ENROUTE_PICKUP"}},"reason_required":true},{"cancellation_fee":{"amount":{"currency":"INR","value":"50"}},"fulfillment_state":{"descriptor":{"code":"RIDE_ARRIVED_PICKUP"}},"reason_required":true},{"cancellation_fee":{"percentage":"100"},"fulfillment_state":{"descriptor":{"code":"RIDE_STARTED"}},"reason_required":true}],"fulfillments":[{"id":"F1","state":{"descriptor":{"code":"RIDE_ENDED"}},"stops":[{"authorization":{"token":"234234","type":"OTP","valid_to":"2023-12-10T08:05:34.294Z","status":"CLAIMED"},"location":{"gps":"13.008935, 77.644408"},"type":"START","instructions":{"short_desc":"short description of the location","long_desc":"long description of the location"}},{"location":{"gps":"12.971186, 77.586812"},"type":"END"}],"agent":{"contact":{"phone":"9856798567"},"person":{"name":"Jason Roy","image":{"url":"https://example-bpp.com/prod/seller/images/agent/profile-image.png","size_type":"sm"}},"rating":"5"},"customer":{"contact":{"phone":"9876556789"},"person":{"name":"Joe Adams"}},"tags":[{"descriptor":{"code":"ROUTE_INFO","name":"Route Information"},"display":true,"list":[{"descriptor":{"code":"ENCODED_POLYLINE","name":"Path"},"value":"_p~iF~ps|U_ulLnnqC_mqNvxq`@"},{"descriptor":{"code":"WAYPOINTS","name":"Waypoints"},"value":"[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"}]}],"type":"SELF_PICKUP","vehicle":{"category":"AUTO_RICKSHAW","variant":"AUTO_RICKSHAW","make":"Bajaj","model":"Compact RE","registration":"KA-01-AD-9876"}}],"id":"O1","items":[{"descriptor":{"code":"RIDE","name":"Auto Ride"},"category_ids":["C1"],"fulfillment_ids":["F1"],"id":"I1","location_ids":["L1","L3"],"payment_ids":["PA1"],"price":{"currency":"INR","value":"146"},"tags":[{"descriptor":{"code":"FARE_POLICY","name":"Daytime Charges"},"display":true,"list":[{"descriptor":{"code":"MIN_FARE"},"value":"30"},{"descriptor":{"code":"MIN_FARE_DISTANCE_KM"},"value":"2"},{"descriptor":{"code":"PER_KM_CHARGE"},"value":"15"},{"descriptor":{"code":"PICKUP_CHARGE"},"value":"10"},{"descriptor":{"code":"WAITING_CHARGE_PER_MIN"},"value":"2"},{"descriptor":{"code":"FREE_WAIT_TIME_PERIOD","short_desc":"Describes the waiting charges applicable after the defined free waiting period, once the driver reaches the pickup location."},"value":"PT10M"},{"descriptor":{"code":"NIGHT_CHARGE_MULTIPLIER"},"value":"1.5"},{"descriptor":{"code":"NIGHT_SHIFT_START_TIME"},"value":"22:00:00"},{"descriptor":{"code":"NIGHT_SHIFT_END_TIME"},"value":"05:00:00"},{"descriptor":{"code":"DEAD_KM_FARE"},"value":"10"}]},{"descriptor":{"code":"INFO","name":"General Information"},"display":true,"list":[{"descriptor":{"code":"DISTANCE_TO_NEAREST_DRIVER_METER"},"value":"661"},{"descriptor":{"code":"ETA_TO_NEAREST_DRIVER_MIN"},"value":"3"}]}]}],"payments":[{"collected_by":"BPP","id":"PA1","status":"NOT_PAID","type":"ON_FULFILLMENT"}],"provider":{"id":"P1"},"quote":{"breakup":[{"price":{"currency":"INR","value":"30"},"title":"BASE_FARE"},{"price":{"currency":"INR","value":"116"},"title":"DISTANCE_FARE"}],"price":{"currency":"INR","value":"146"},"ttl":"PT30S"},"status":"ACTIVE","created_at":"2023-12-10T08:03:34.294Z","updated_at":"2023-12-10T08:03:34.294Z","tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]},{"descriptor":{"code":"BPP_TERMS","name":"BPP Terms of Engagement"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"rating":{"examples":[{"summary":"Provide_a_rating___X27","value":{"context":{"action":"rating","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"b462a835-97d6-4479-bec8-9660a0f8513e","timestamp":"2023-03-23T04:46:45Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"id":"b0462745-f6c9-4100-bbe7-4fa3648b6b40","rating_category":"DRIVER","value":4}}},{"summary":"Provide_a_rating_with_feedback_form_data___X28","value":{"context":{"action":"rating","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"849db48a-34c0-454b-86cb-60864482941b","timestamp":"2023-03-23T04:46:45Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"feedback_form":[{"answer":"Driver took me on a route not shown by Google Maps and we reached 10 minutes before time","id":"1"}],"id":"b0462745-f6c9-4100-bbe7-4fa3648b6b40","rating_category":"DRIVER","value":4}}}]},"search":{"examples":[{"summary":"Search_for_mobility_services_by_pickup_and_drop_location[Buyer_Collecting]___X2","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:40:21.452Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}],"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"}}}}},{"summary":"Search_for_mobility_services_by_pickup_and_drop_location[Seller_Collecting]___X1","value":{"context":{"action":"search","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"40963dc1-e402-4f4d-ae70-7c5864ca682c","timestamp":"2023-12-09T13:39:56.645Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"intent":{"category":{"descriptor":{"code":"ON_DEMAND_TRIP"}},"fulfillment":{"stops":[{"location":{"gps":"13.008935, 77.644408","address":"2nd & 3rd Floor, 7/6, August Kranti Marg, Siri Fort Institutional Area","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110049"},"type":"START"},{"location":{"gps":"12.971186, 77.586812","address":"Jai Singh Road, Connaught Place, New Delhi","city":{"code":"std:080"},"district":"New Delhi","country":{"code":"IND"},"area_code":"110001"},"type":"END"}]},"payment":{"collected_by":"BPP"},"tags":[{"descriptor":{"name":"BAP Terms of Engagement","code":"BAP_TERMS"},"display":false,"list":[{"descriptor":{"code":"STATIC_TERMS"},"value":"https://example-test-bap.com/static-terms.txt"},{"descriptor":{"code":"OFFLINE_CONTRACT"},"value":"true"}]}]}}}}]},"select":{"examples":[{"summary":"Get_quote_for_a_specific_product_from_a_mobility_catalog___X3","value":{"context":{"action":"select","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"432fdfd6-0457-47b6-9fac-80cbe5c0a75b","timestamp":"2023-12-09T13:49:01.460Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"P120S","version":"2.1.0"},"message":{"order":{"items":[{"id":"I1","add_ons":[{"id":"A1","quantity":{"selected":{"count":3}}}]}],"fulfillments":[{"id":"F1"}],"provider":{"id":"P1"}}}}}]},"status":{"examples":[{"summary":"Get_latest_fulfillment_status_of_a_booking___X29","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}},{"summary":"status_buyer_app_requests_the_ride_provider_to_provide_the_latest_order_status_4","description":"TBD","value":{"context":{"action":"status","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"d883e7f9-f6bc-4ddf-b64c-a2bc44e63ae2","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"ref_id":"870782be-6757-43f1-945c-8eeaf9536259"}}}]},"support":{"examples":[{"summary":"Fetch_support_information_related_to_a_particular_order___X30","value":{"context":{"action":"support","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"support":{"ref_id":"7751bd26-3fdc-47ca-9b64-e998dc5abe68"}}}}]},"track":{"examples":[{"summary":"Track_an_active_ride___X31","value":{"context":{"action":"track","bap_id":"example-bap.com","bap_uri":"https://example-bap.com/prod/trv10","bpp_id":"example-bpp.com","bpp_uri":"https://example-bpp.com/prod/seller","domain":"ONDC:TRV10","location":{"city":{"code":"std:080"},"country":{"code":"IND"}},"message_id":"8926b747-0362-4fcc-b795-0994a6287700","timestamp":"2023-03-23T04:48:53Z","transaction_id":"870782be-6757-43f1-945c-8eeaf9536259","ttl":"PT30S","version":"2.1.0"},"message":{"order_id":"O1"}}}]}}}},"x-attributes":{"on-demand":{"attribute_set":{"search":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"search","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"}},"message":{"intent":{"fulfillment":{"customer":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the customer gender."}}},"agent":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"Describes the type of the stops during the fulfillment of order"},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"12.923608, 77.614629","description":"Describes the GPS co-ordinates of this location."},"address":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2nd & 3rd Floor, 7/6, August Kranti Marg","description":"Describes the address of the location."},"city":{"code":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code."}},"district":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"New Delhi","description":"Describes the district value."},"country":{"code":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"IND","description":"Describes the country code."}},"area_code":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"110049","description":"Describes the area code."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describe the location of the stop"}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"The list of logical stops encountered during the fulfillment of an order."}},"vehicle":{"category":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle category."},"variant":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"OPTIONAL","type":"object","owner":"BAP","usage":"--","description":"Describes a vehicle is a device that is designed or used to transport people or cargo over land, water, air, or through space.
This has properties like category, capacity, make, model, size,variant,color,energy_type,registration"}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"}},"payment":{"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BPP","description":"This field indicates the payment collector. If set to 'bap,' BAP collects first and settles with BPP. If BPP agrees, no payment link is sent. If set to 'bpp,' BPP collects payment directly."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"The terms of settlement for this order"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This helps the system to find out the purpose of the user behind choosing any product or service. By using this intent the system can align relevant options from available products or service."}}}},"on_search":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_search","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"catalog":{"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Mobility Servies BPP","description":"Describes the catalog name."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the catalog's descriptor."}},"providers":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unique Id of the provider."},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"locations":{"id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Indicates provider locations where this item is available."},"gps":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"28.707358, 77.180910","description":"Describes the GPS co-ordinates of this location."},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's locations."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Describes the unique reference ID to the fulfillment of an order"},"customer":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the customer gender."}}},"agent":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."}}},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DELIVERY","description":"A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. "},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"Describes the type of the stops during the fulfillment of order"},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.707358, 77.180910","description":"Describes the GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle category."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"energy_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"CAB","description":"Describes the vehicle energy type."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"}},"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"CAB Economy Ride","description":"Describes the unique code value of the item"},"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the name value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value of price in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value price in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Indicates the locations where this item is available from providers."},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Describes the Unique reference ID for order fulfillment."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"payments":{"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BPP","description":"This field indicates who is the collector of payment. "},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the terms of settlement between the BAP and the BPP for a single transaction"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Denotes settlement amount"}}}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the catalog's description."}}}},"select":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"select","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This decription refers to the comprehensive list of the products or services selected and obtained within the specified order."}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unique Id of the provider."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This describes the complete formulated description of the loan provider whose catalog items have been selected."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the legal contract created between the buyer and the seller."}}}},"on_select":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_select","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the unique code value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value of price in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value of price in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Provider Locations this item is available in"},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unique Id of the provider."},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"DELIVERY","description":"A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. "},"customer":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the customer gender."}}},"agent":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"Describes the type of the stops during the fulfillment of order"},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"Describes the GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle category."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"energy_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"CAB","description":"Describes the vehicle energy type."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency to be paid in of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the order description."}}}},"init":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"init","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This decription refers to the comprehensive list of the products or services selected and obtained within the specified order."}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Id of the provider"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This describes the complete formulated description of the loan provider whose catalog items have been selected."}},"billing":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"John Doe","description":"Name of the billable entity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"The billing details of this order"}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes contact of end-customer"}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes contact of end-customer"}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.707358, 77.180910","description":"The GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes vehicle category"},"variant":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"OPTIONAL","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"}},"payments":{"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Payment status"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Payment Type"},"params":{"bank_code":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the payment params for this order."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"The terms of settlement for this order"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"This refers to the complete description of the legal contract created between the buyer and the seller."}}}},"on_init":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_init","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145-4ea3-45fe-ab3d-7bcf6b9f456b","description":"Describes the unique Id of the item."},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the unique code value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of selected item."},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value of price in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value of price in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Indicates the locations where this item is available from providers."},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unqiue Id of the provider"},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DELIVERY","description":"A code that describes the mode of fulfillment."},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"Describes the GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle category."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"energy_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"CAB","description":"Describes the vehicle energy type."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Describes the name of the customer"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Describes the contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"}}},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency to be paid in of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the price of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Describes the ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Describe the payment Status for particular order"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Describe the payment type for particular order"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the payment params for this order."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"The terms of settlement for this order"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."},"id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."}}}},"confirm":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"confirm","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This decription refers to the comprehensive list of the products or services selected and obtained within the specified order."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the uique Id of the provider."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This describes the complete formulated description of the loan provider whose catalog items have been selected."}},"billing":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"John Doe","description":"Describes the Name of the billable entity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"The billing details of this order"}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"bc08edb1","description":"ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Describe the payment Status for particular order"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Describe the payment type for particular order"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"transaction_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"cda41144","description":"Describes transaction ID associated with payment activity"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the payment params for this order."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"The terms of settlement for this order"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Describe the name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes contact of end-customer"}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Describe the contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes contact of end-customer"}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"Describes the type of the stops during the fulfillment of order"},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"The GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes vehicle category"},"variant":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"OPTIONAL","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"This refers to the complete description of the legal contract created between the buyer and the seller."},"id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."}}}},"on_confirm":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_confirm","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique Id of the item."},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Single Journey Ticket","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"SJT","description":"Describes the unique code value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type to be paid in of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Indicates the locations where this item is available from providers."},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"P1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Unique reference ID to the payment of an order"},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"P1","description":"Unique reference ID to the payment of an order"},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Describes the name of the customer"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Describes the contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"John Doe","description":"Describes the name of the agent"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"},"image":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/images","description":"Describes the agent image"},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the size type of image"}},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the agent details."}},"rating":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"5","description":"Describes the agent rating."},"contact":{"phone":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":7845981268,"description":"Describes the contact number of the agent"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent."}},"state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ASSIGNED","description":"Describes the state's code for fulfillment."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the fulfillments description."}}},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"INTERMEDIATE_STOP","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.707358, 77.180910","description":"The GPS co-ordinates of this location."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"authorization":{"type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"OTP","description":"Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy."},"token":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":232312,"description":"Token used for authorization. This is typically generated at the BPP. The BAP can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering."},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the authorization for a fulfillments stop."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"AUTO_RICKSHAW","description":"Describes vehicle category"},"make":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Bajaj","description":"Describes vehicle manufacturer"},"model":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"compact-re","description":"Describes vehicle model"},"registration":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"HR-20AS-4578","description":"Describes vehicle registration details"},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the vehicle type."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency to be paid in of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Describes the ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Describe the Payment Status"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Describe the Payment type"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"amount":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":146,"description":"Describes the amount associated with the payment transaction"},"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency associated with the payment transaction"},"transaction_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"cda41144","description":"Describes transaction ID associated with payment activity"}},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"status":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ACTIVE","description":"Describes the order status."},"created_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes the date-time of creation of this order"},"updated_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes The date-time of updated of this order"},"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."}}}},"cancel":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"cancel","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"60253df1","description":"Describes the unique ID of the order. "},"cancellation_reason_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"45dd6fd3","description":"Describes the reason Id for cancellation"},"descriptor":{"short_desc":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"Accidantaly book the ride","description":"Describes the Short description for cancellaion"},"name":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"Ride Cancellation","description":"Describes the name for cancellaion"},"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"SOFT_CANCEL","description":"Describes the code for cancellaion"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This include the details about the distinctive features, benefits, or unique aspects of the products or service that has been offered to the end customer."}}}},"on_cancel":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_cancel","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique ID of the order. "},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the unique code value of the item"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Describes the unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Describes the unique reference ID to the payment of an order"},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Provider Locations this item is available in"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type to be paid in of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Describes the unique ID of the provider."},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"Describes a GPS coordinate"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"authorization":{"type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"OTP","description":"Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy."},"token":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":232312,"description":"Token used for authorization. This is typically generated at the BPP. The BAP can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering."}},"time":{"duration":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"PT2H","description":"Describes the duration."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the fulfillments stops."}},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"Jason Roy","description":"Name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"John Doe","description":"Describes the name of the agent"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"},"image":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/images","description":"Describes the agent image"},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the size type of image"}},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the agent details."}},"rating":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"5","description":"Describes the agent rating."},"contact":{"phone":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":7845981268,"description":"Describes the contact number of the agent"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent."}},"vehicle":{"registration":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"HR-20AS-4578","description":"Describes vehicle registration details"},"category":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"AUTO_RICKSHAW","description":"Describes vehicle category"},"make":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Bajaj","description":"Describes vehicle manufacturer"},"model":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"compact-re","description":"Describes vehicle model"},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the vehicle type."}},"state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DRIVER_ENROUTE","description":"Describes the state's code for fulfillment."},"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Driver is on the way","description":"Describes the current state"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the fulfillments description."}}},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"P1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Describes the Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency type of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"ID of the payment term that can be referred at an item or an order level in a catalog"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Describe the Payment type"},"params":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes currency value in string form"},"amount":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":60,"description":"Describes a numerical value in decimal form"},"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"bank_account_name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Raghvinder J","description":"Describes the Bank account holder name"},"virtual_payment_address":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"}},"time":{"duration":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P1D","description":"Describes time transaction duration"}},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Describe the Payment Status"},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."},"status":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"SOFT_CANCEL","description":"Describes the order status."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."},"documents":{"descriptor":{"code":{"required":"OPTIONAL","usage":"INVOICE","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"string"},"name":{"required":"OPTIONAL","usage":"Invoice Document","description":"It refers to the specific name of the document","owner":"BPP","type":"string"},"short_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the concised description of the document","owner":"BPP","type":"string"},"long_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the brief description of the document","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"object"}},"mime_type":{"required":"OPTIONAL","usage":"application/pdf","description":"It refers to the categorization of the document based on its file format and content type.","owner":"BPP","type":"string"},"url":{"required":"OPTIONAL","usage":"https://seller.com/loan/invoice/O1.pdf","description":"This describes the url from where the document can be accessed","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the set of documents that are associated to a particular order","owner":"BPP","type":"object"}}}}},"status":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"status","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"60253df1","description":"Describes the unique ID of the order. "},"ref_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"60253df1","description":"Describes unique id for reference, pre-order this will be transaction ID."}}},"on_status":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_status","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique ID of the item. "},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name."},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the item code."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes a numerical value in decimal form"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Provider Locations this item is available in"},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Id of the provider"},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"28.686576, 77.441632","description":"Describes a GPS coordinate"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the location of stops."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"CAB","description":"Describes vehicle category"},"make":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Bajaj","description":"Describes vehicle manufacturer"},"model":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"compact-re","description":"Describes vehicle model"},"registration":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"HR-20AS-4578","description":"Describes vehicle registration details"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the vehicle type."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."}},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Jason Roy","description":"Name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BPP","usage":9898657512,"description":"Contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"John Doe","description":"Describes the name of the agent"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"},"image":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/images","description":"Describes the agent image"},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the size type of image"}},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the agent details."}},"rating":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"5","description":"Describes the agent rating."},"contact":{"phone":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":7845981268,"description":"Describes the contact number of the agent"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent."}},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Delivery","description":"Describes type of fullfilment"},"state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DRIVER_ENROUTE","description":"Describes the state's code for fulfillment."},"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Driver is on the way","description":"Describes the current state"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the fulfillments description."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency to be paid in of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"PA1","description":"ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Payment Status"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Payment type"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"},"transaction_id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"cda41144","description":"Describes transaction ID associated with payment activity"},"amount":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":146,"description":"Describes the amount associated with the payment transaction"},"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency associated with the payment transaction"}},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"status":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"ACTIVE","description":"Describes the order status."},"created_at":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes the date-time of creation of this order"},"updated_at":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes The date-time of updated of this order"},"id":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."},"documents":{"descriptor":{"code":{"required":"OPTIONAL","usage":"INVOICE","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"string"},"name":{"required":"OPTIONAL","usage":"Invoice Document","description":"It refers to the specific name of the document","owner":"BPP","type":"string"},"short_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the concised description of the document","owner":"BPP","type":"string"},"long_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the brief description of the document","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"object"}},"mime_type":{"required":"OPTIONAL","usage":"application/pdf","description":"It refers to the categorization of the document based on its file format and content type.","owner":"BPP","type":"string"},"url":{"required":"OPTIONAL","usage":"https://seller.com/loan/invoice/O1.pdf","description":"This describes the url from where the document can be accessed","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the set of documents that are associated to a particular order","owner":"BPP","type":"object"}}}}},"update":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_status","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":1,"description":"Describes the unique order id"},"fulfillments":{"customer":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"John Adam","description":"Name of the customer"}}},"_description":{"required":"OPTIONAL","type":"object","owner":"BAP/BPP","usage":"--","description":"Name of the customer"}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the unique order id"}}}},"on_update":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the country of location where the transaction is meant to be completed."}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the city of location where the transaction is meant to be completed."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"This attribute defines the location where the transaction is meant to be completed."}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_update","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order":{"items":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ecf4d145","description":"Describes the unique ID of the item. "},"descriptor":{"name":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Auto Ride","description":"Describes the item name. "},"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE","description":"Describes the item code. "},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the items description."}},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency type of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes a numerical value in decimal form"},"maximum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":176,"description":"Describes a maximum value in decimal form"},"minimum_value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":50,"description":"Describes a minimum value in decimal form"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of an item."}},"location_ids":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"d3ebf05b","description":"Provider Locations this item is available in"},"fulfillment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"payment_ids":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"bc08edb1","description":"Unique reference ID to the payment of an order"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item."},"tags":{"FARE_POLICY":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Details about fare for the ride","list":{"MIN_FARE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare"},"MIN_FARE_DISTANCE_KM":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the minimum fare per KM"},"PER_KM_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the per km charge"},"PICKUP_CHARGE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the pickup charge"},"WAITING_CHARGE_PER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waiting charge per minute"},"NIGHT_CHARGE_MULTIPLIER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the times need to multiply for night charge"},"NIGHT_SHIFT_START_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift starts"},"NIGHT_SHIFT_END_TIME":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the time when night shift ends"}}},"INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the general info about the ride","list":{"DISTANCE_TO_NEAREST_DRIVER_METER":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the distance to nearest driver."},"ETA_TO_NEAREST_DRIVER_MIN":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the ETA to nearest driver."}}}}},"provider":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"450dec0f","description":"Id of the provider"},"descriptor":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber","description":"Describes the provdier name."},"short_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides","description":"Describes the provdier short_desc."},"long_desc":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Uber Rides, India","description":"Describes the provdier long_desc."},"images":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/asset","description":"Describes the provdier image url."},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the provdier image size type."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the provider's description."}},"fulfillments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"b68bb35b","description":"Unique reference ID to the fulfillment of an order"},"stops":{"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"START","description":"The type of stop. Allowed values of this property can be defined by the network policy."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"28.686576, 77.441632","description":"Describes a GPS coordinate"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the location of stops."}},"authorization":{"type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"OTP","description":"Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy."},"token":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":232312,"description":"Token used for authorization. This is typically generated at the BPP. The BAP can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering."},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the authorization for a fulfillments stop."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the fulfillments stops."}},"vehicle":{"category":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"CAB","description":"Describes vehicle category"},"make":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Bajaj","description":"Describes vehicle manufacturer"},"model":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"compact-re","description":"Describes vehicle model"},"registration":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"HR-20AS-4578","description":"Describes vehicle registration details"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the vehicle type."},"variant":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"CAB","description":"Describes the vehicle variant."}},"customer":{"person":{"name":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"John Adam","description":"Name of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer details."}},"contact":{"phone":{"required":"MANDATORY","type":"string","owner":"BAP","usage":9898657512,"description":"Contact number of the customer"},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP","usage":"--","description":"Describes the customer."}},"agent":{"person":{"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"John Doe","description":"Describes the name of the agent"},"gender":{"required":"optional","type":"string","owner":"BAP","usage":"FEMALE","description":"Describes the agent gender"},"image":{"url":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"https://example-bpp.com/prod/seller/images","description":"Describes the agent image"},"size_type":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"sm","description":"Describes the size type of image"}},"_description":{"required":"OPTIONAL","type":"object","owner":"BPP","usage":"--","description":"Describes the agent details."}},"rating":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"5","description":"Describes the agent rating."},"contact":{"phone":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":7845981268,"description":"Describes the contact number of the agent"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent contact details."}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the agent."}},"type":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Delivery","description":"Describes type of fullfilment"},"state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"DRIVER_ENROUTE","description":"Describes the state's code for fulfillment."},"name":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"Driver is on the way","description":"Describes the current state"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the fulfillments description."}}},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes how a an order will be rendered/fulfilled to the end-customer"},"tags":{"ROUTE_INFO":{"required":"MANDATORY","type":"OBJECT","owner":"BPP","usage":"--","description":"Describes the route information.","list":{"ENCODED_POLYLINE":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the encoded polyline value."},"WAYPOINTS":{"required":"MANDATORY","type":"TEXT","owner":"BPP","usage":"--","description":"Describes the waypoints value."}}}}},"quote":{"price":{"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":60,"description":"Describes the price of a product or service"},"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the value of used currency of quoted price."}},"breakup":{"title":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"Base Fare","description":"Breakup title of the total quoted price"},"price":{"currency":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"INR","description":"Describes the price of a product or service"},"value":{"required":"MANDATORY","type":"string","owner":"BPP","usage":120,"description":"Describes the currency to be paid in of a product or service"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the breakup price"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This attribute describes the breakup of the total quoted price."}},"ttl":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"P200s","description":"Time to live in seconds for an instance of this schema"},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"This refers to the complete description of the mutually agreed upon quotation for this order."}},"payments":{"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"PA1","description":"ID of the payment term that can be referred at an item or an order level in a catalog"},"collected_by":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"BAP","description":"This field indicates who is the collector of payment. "},"status":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"NOT-PAID","description":"Payment Status"},"type":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PRE_ORDER","description":"Payment type"},"params":{"bank_code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"XXXXXXXX","description":"Bank code associated with payment activity"},"bank_account_number":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"xxxxxxxxxxxxxx","description":"Bank account number associated with payment activity"},"virtual_payment_address":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"9988199772@okicic","description":"Virtual payment address associated with payment activity"}},"tags":{"BUYER_FINDER_FEES":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the finder fees for buyer","list":{"BUYER_FINDER_FEES_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee type"},"BUYER_FINDER_FEES_PERCENTAGE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in percentage"},"BUYER_FINDER_FEES_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Buyer finder fee in amount"}}},"SETTLEMENT_TERMS":{"required":"MANDATORY","type":"OBJECT","owner":"BAP","usage":"--","description":"Describes the settlement terms","list":{"SETTLEMENT_WINDOW":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Time window to complete settlement"},"SETTLEMENT_BASIS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Basis required to complete settlement"},"SETTLEMENT_TYPE":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Payment method to complete settlement"},"MANDATORY_ARBITRATION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Flag to denote if dispute can be resolved through arbitration"},"COURT_JURISDICTION":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes court that will have jurisdiction for the case"},"DELAY_INTEREST":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes interest to be paid as a delay charge"},"STATIC_TERMS":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Terms for settlement"},"SETTLEMENT_AMOUNT":{"required":"MANDATORY","type":"TEXT","owner":"BAP","usage":"--","description":"Denotes settlement amount"}}}}},"cancellation_terms":{"fulfillment_state":{"descriptor":{"code":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"RIDE_ENROUTE_PICKUP","description":"Describes the unique code for the cancellation terms."},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}}},"reason_required":{"required":"MANDATORY","type":"string","owner":"BPP","usage":true,"description":"Indicates whether a reason is required to cancel the order"},"cancellation_fee":{"percentage":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":2,"description":"Describes the percentage value for cancellation fee"},"amount":{"currency":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":"INR","description":"Describes the currency of a product or service"},"value":{"required":"OPTIONAL","type":"string","owner":"BPP","usage":30,"description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the price of a product or service"}},"_description":{"required":"MANDATORY","type":"object","owner":"BPP","usage":"--","description":"Describes the unique code for the cancellation terms"}},"status":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"COMPLETED","description":"Describes the order status."},"created_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes the date-time of creation of this order"},"updated_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-12-10T08:03:34.294Z","description":"Describes The date-time of updated of this order"},"billing":{"name":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"John Doe","description":"Describes the Name of the billable entity"},"email":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":"jane.doe@example.com","description":"Describes the email of the billable entity"},"phone":{"required":"OPTIONAL","type":"string","owner":"BAP","usage":9897867564,"description":"Describes the contact number of the billable entity"}},"id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"ec08edb2","description":"Describes the unqiue order ID."},"_description":{"required":"MANDATORY","type":"object","owner":"BAP/BPP","usage":"--","description":"Describes the order description."},"documents":{"descriptor":{"code":{"required":"OPTIONAL","usage":"INVOICE","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"string"},"name":{"required":"OPTIONAL","usage":"Invoice Document","description":"It refers to the specific name of the document","owner":"BPP","type":"string"},"short_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the concised description of the document","owner":"BPP","type":"string"},"long_desc":{"required":"OPTIONAL","usage":"Download your Invoice Document here","description":"This refers to the brief description of the document","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the unique descriptor identifier used for the document","owner":"BPP","type":"object"}},"mime_type":{"required":"OPTIONAL","usage":"application/pdf","description":"It refers to the categorization of the document based on its file format and content type.","owner":"BPP","type":"string"},"url":{"required":"OPTIONAL","usage":"https://seller.com/loan/invoice/O1.pdf","description":"This describes the url from where the document can be accessed","owner":"BPP","type":"string"},"_description":{"required":"OPTIONAL","usage":"--","description":"It refers to the set of documents that are associated to a particular order","owner":"BPP","type":"object"}}}}},"track":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"track","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"order_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"O1","description":"Describes the order ID."}}},"on_track":{"context":{"location":{"country":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"IND","description":"Describes country code as per ISO 3166-1 and ISO 3166-2 format"}},"city":{"code":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"std:080","description":"Describes the city code this location is, or is located within"}}},"domain":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"ONDC:TRV10","description":"Describes domain code that is relevant to this transaction context"},"timestamp":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"2023-03-23T04:41:16.000Z","description":"Describes tme of request generation in RFC3339 format"},"bap_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"api.example-bap.com","description":"Describes subscriber ID of the BAP"},"transaction_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"6743e9e2","description":"Describes a unique value which persists across all API calls"},"message_id":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"13ba8018f176","description":"Describes a unique value which persists during a request / callback cycle."},"version":{"required":"MANDATORY","type":"integer","owner":"BAP","usage":"2.0.0","description":"Describes the version of transaction protocol being used by the sender."},"action":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"on_track","description":"Describes the Beckn protocol method being called by the sender and executed at the receiver."},"bap_uri":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"https://api.example-bap.com/pilot/bap/cab/v1","description":"Describes subscriber URL of the BAP for accepting callbacks from BPPs."},"ttl":{"required":"MANDATORY","type":"string","owner":"BAP","usage":"PT30S","description":"Describes the duration in ISO8601 format after timestamp for which this message holds valid"},"bpp_id":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"api.example-bpp.com","description":"Describes subscriber ID of the BPP"},"bpp_uri":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"https://api.example-bpp.com/dobpp/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f","description":"Describes subscriber URL of the BPP for accepting calls from BAPs."}},"message":{"tracking":{"status":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"O1","description":"Describes the order status."},"location":{"gps":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"28.620976, 77.046732","description":"Describes the gps value."},"updated_at":{"required":"MANDATORY","type":"string","owner":"BPP","usage":"2023-03-23T05:41:09Z","description":"Describes the updated_at value."}}}}}}}},"x-errorcodes":{"code":[{"Event":"Route Serviceability error","Description":"To & from location not serviceable by Seller application","From":"BPP","code":90201},{"Event":"Tracking not enabled","Description":"Tracking not enabled for any fulfillment in the order","From":"BPP","code":90202},{"Event":"Driver not assigned","Description":"Driver not assigned to the order","From":"BPP","code":90203}]},"x-tlc":{"code":[{"Term":"Payment Collector ","Api":"search/on_search/init/on_init\t","Attribute":"payment.collected_by ","Owner":"Either","Value":"“BAP”, “BPP” ","Description":"If set to “BAP”, it means that the Buyer App will collect payment from the Buyer.\nIf set to “BPP”, it means that the Seller App will collect payment from the Buyer."},{"Term":"Payment Type ","Api":"init/on_init ","Attribute":"payment.type ","Owner":"Either","Value":"“ON-ORDER”, “ON_FULFILLMENT”\n","Description":"How payment is going to be collected from the Buyer. If this parameter is set to “ON-ORDER”, that means it is a pre-paid order, i.e. the payment is collected at the time of order confirmation. If this parameter is set to “ON_FULFILLMENT”, that means it is a pay at the end of the trip, i.e. the payment is collected when the trip ends."},{"Term":"Item Cancellability ","Api":"search/on_search/init/on_init\t","Attribute":"Handled in cancellation terms ","Owner":"Seller App\t","Value":"true/ false\t","Description":"Whether the order for that item can be canceled after being confirmed. If set to “TRUE” that means the Seller allows the Buyer to cancel the order for the item in question, after confirmation."},{"Term":"Static Terms","Api":"search/on_search/init/on_init\t","Attribute":"STATIC_TERMS","Owner":"Seller App & Buyer App","Value":"URL","Description":"This will be the URL of a web-page where the standard Terms and Conditions of the Network Participant - which are not covered in the API Specification (e.g.: indemnity) - will be hosted. These terms will apply to the transaction, in addition to the terms decided through the ONDC Protocol. If there is a conflict between the terms decided through the Protocol, and the Static Terms, the terms decided through the ONDC Protocol will prevail. Also, if there is a conflict between the Static Terms and the ONDC Network Policy or the Static Terms and the Network Participant Agreement, the terms of the ONDC Network Policy or the Network Participant Agreement (as the case may be) will prevail."}]},"x-featureui":{"filenames":["document_sharing.md"]},"x-sandboxui":{"dropdown":[{"environment-name":"staging","link":"https://mobility-staging.ondc.org"}]},"x-changeLog":{"filenames":["TRV10_2.1.0_030924.md"]}} \ No newline at end of file From b55214b08e859f4f9aca3a0635ebb40b2ea23c19 Mon Sep 17 00:00:00 2001 From: Anuj Sharma Date: Mon, 17 Aug 2026 15:16:54 +0530 Subject: [PATCH 4/4] feat: added enum codes for support/on_support --- api/components/docs/changeLog/TRV10_2.1.0_030924.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/api/components/docs/changeLog/TRV10_2.1.0_030924.md b/api/components/docs/changeLog/TRV10_2.1.0_030924.md index 9a91ac05..dc3b6ed2 100644 --- a/api/components/docs/changeLog/TRV10_2.1.0_030924.md +++ b/api/components/docs/changeLog/TRV10_2.1.0_030924.md @@ -116,11 +116,15 @@ For example: - ```cancellation: + ``` + cancellation: reason: descriptor: code: "999" short_desc: "Customer requested cancellation" ``` - + - Added enums for support/on_support calls. + - SOS + - LONG_HALT + - ROUTE_DEV --- \ No newline at end of file