7 Data Structures
This section provides information on the core data structures/data models that are used by this Building Block.
Last updated
This section provides information on the core data structures/data models that are used by this Building Block.
Last updated
Copyright © 2024
The proposed resource model showing the relationship between data objects that are used by this Building Block is illustrated in the diagram below.
Description: Outlines 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 Provider Platform must be responded to with an Ack whether the Provider Platform intends to respond with a callback or not. This has the property status that indicates the state of the Acknowledgement.
Fields:
Description: Shows 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.
Fields:
Description: Outlines a postal address that is stored as a string value.
Description: Outlines the direct performer, driver or executor that fulfils 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 a 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 Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during a search. This object can also be used to search for a particular person that the customer wants to fulfil 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.
Fields:
Description: Outlines an authorization mechanism used to start or end the fulfilment 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.
Fields:
Description: Outlines the billing details of an entity. This has properties like name, organization, address, email, phone, time, tax_number, created_at,updated_at.
Fields:
Description: Outlines a cancellation event.
Fields:
Description: Outlines 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.
Fields:
Description: Outlines the products or services offered by a Provider Platform. This is typically sent as the response to a search intent from an Application Platform. The payment terms, offers and terms of fulfilment supported by the Provider Platform can also be included here. The Provider Platform can show the hierarchical nature of products/services in its catalog using the parent_category_id in categories. The Provider Platform can also send a TTL (time to live) in the context which is the duration for which an Application Platform can cache the catalog and use the cached catalog. This has properties for Business to Business Procurement (BBP) like descriptor/categories/fulfillments/payments/offers/providers/exp. This is used in the following situations. This is typically used in the discovery stage when the Provider Platform sends the details of the products and services it offers as a response to a search intent from the Application Platform.
Fields:
Description: A label under which a collection of items can be grouped.
Fields:
Description: Describes a circular region of a specified radius centered at a specified GPS coordinate.
Fields:
Description: Outlines a city
Fields:
Description: Outlines the contact information of an entity.
Fields:
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 Application Platform that sets the transaction context based on the consumer's location and action on their UI. But sometimes, during unsolicited callbacks, the Provider Platform also sets the transaction context but it is usually the same as the context of a previous full-cycle, request-callback interaction between the Application Platform and the Provider Platform. The context object contains four types of fields. Demographic information about the transaction using fields like domain, country, and region. Addressing details like the sending and receiving platform's ID and API URL. Interoperability information like the protocol version that is implemented by the sender and 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 Application Platform, a message ID to pair requests with callbacks, a timestamp to capture sending times, a ttl to specify the validity of the request, and a key to encrypt information if necessary. This object must be passed in every interaction between an Application Platform and a Provider Platform. 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.
Fields:
Description: Outlines a country.
Fields:
Description: Outlines a credential of an entity (Person or Organization).
Fields:
Description: Outlines a customer buying/availing a product or a service.
Fields:
Description: Outlines a numerical value in decimal form. The string value should match the pattern "[+-]?([0-9]*[.])?[0-9]+".
Description: Physical description of something.
Fields:
Description: Outlines 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 Provider Platforms that don't have services supporting the domain. Too narrow domains will result in a large number of registry entries for each Provider Platform. 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.
Fields:
Description: Outlines duration as per ISO8601 format.
Description: Outlines an error object that is returned by an Application Platform, Provider Platform 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.
Fields:
Description: A fee applied to a particular entity.
Fields:
Description: Outlines a form.
Fields:
Description: Outlines how an order will be rendered/fulfilled to the end customer.
Fields:
Description: Outlines the state of fulfilment.
Fields:
Description: Outlines a GPS coordinate. The string value should be of the pattern "^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$".
Description: Outlines an image.
Fields:
Description: The intent to buy or avail of a product or a service. The Application Platform 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 fulfilment/How they want to pay for it/This has properties like descriptor, provider, fulfilment, payment, category, offer, item, tags. This is typically used by the Application Platform to send the purpose of the user's search to the Provider Platform. This will be used by the Provider Platform 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 or scan (intent.fulfillment.end.time)/Who is the service provider they would like to avail services from (intent.provider)/Who is getting the test or scan (intent.fulfillment.customer)/What kind of test or 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).
Fields:
Description: Outlines the count or amount of an item.
Fields:
Description: Outlines a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like a 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.
Fields:
Description: The physical location of something.
Fields:
Description: This object contains a URL to a media file.
Fields:
Description: An offer associated with a catalog. This is typically used to promote a particular product and enable more purchases.
Fields:
Description: Outlines a selectable option.
Fields:
Description: Outlines a legal purchase order. It contains the complete details of the legal contract created between the buyer and the seller.
Fields:
Description: An organization. Usually a recognized business entity.
Fields:
Description: Outlines the terms of settlement between the Application Platform and the Provider Platform for a single transaction. When instantiated, this object contains the amount that has to be settled/The payment destination details/When the settlement should happen/A transaction reference ID. During a transaction, the Provider Platform reserves the right to decide the terms of payment. However, the Application Platform can send its terms to the Provider Platform first. If the Provider Platform does not agree to those terms, it must overwrite the terms and return them to the Application Platform. If overridden, the Application Platform must either agree to the terms set by the Provider Platform in order to preserve the provider's autonomy or abort the transaction. In case of such disagreements, the Application Platform and the Provider Platform can perform offline negotiations on the payment terms. Once an agreement is reached, the Application Platform and Provider Platform can resume transactions.
Fields:
Description: Outlines a person as any individual.
Fields:
Description: Outlines the price of an Item
Fields:
Description: Outlines the catalog of a business.
Fields:
Description: Outlines a quote. It is the estimated price of products or services from the Provider Platform. This has properties like price, breakup, and TTL.
Fields:
Description: Outlines the rating of an entity.
Fields:
Description: Outlines an arbitrary region of space. The network policy should contain a published list of supported regions by the network.
Fields:
Description: The replacement policy for an item or an order.
Fields:
Description: Outlines the return policy of an item or an order.
Fields:
Description: Outlines a scalar.
Fields:
Description: Outlines 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, and times.
Fields:
Description: A bounded geopolitical region of governance inside a country.
Fields:
Description: A logical point in space and time during the fulfilment of an order.
Fields:
Description: Details of customer support.
Fields:
Description: Outlines 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 Application Platforms, tags can be sent during search to optimize and filter search results. Provider Platforms can use tags to index their catalog to allow better search functionality. Tags are sent by the Provider Platform as part of the catalog response in the on_search callback. Tags are also meant for display purposes. Upon receiving a tag, Application Platforms are meant to render them as name-value pairs. This is particularly useful when rendering tabular information about a product or service.
Fields:
Description: A collection of tag objects with group-level attributes (Documentation on Tag Groups schema).
Fields:
Description: Outlines 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, timestamp, duration, range, days, and schedule.
Fields:
Description: Contains tracking information that can be used by the Application Platform to track the fulfillment of an order in real-time. which is useful for knowing the location of time-sensitive deliveries.
Fields:
Description: Outlines 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, colour,energy_type, and registration.
Fields:
Description: Contains any additional or extended inputs required to confirm an order. This is typically a Form Input. Sometimes, the selection of catalog elements is not enough for the Provider Platform to confirm an order. For example, to confirm a flight ticket, the airline requires details of the passengers along with information on baggage, and identity, in addition to the class of ticket. Similarly, a logistics company may require details on the nature of the 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, they 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 Application Platform must render a separate form for the Item and another form at the Order level before confirmation.
Fields:
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description | Format |
|---|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description | Notes | Enum |
|---|---|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description | Notes | Enum |
|---|---|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description | Notes | Enum |
|---|---|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Enum | Format |
|---|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description | Notes |
|---|---|---|---|
| Name | Type | Description | Format | Enum |
|---|---|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
status
string
The status of the acknowledgement. If the request passes the validation criteria of the Provider Platform, then this is set to ACK. If a Provider Platform 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 Provider Platform does not intend to respond with a callback even after the request meets the validation criteria, it should set this value to NACK.
Enum Data Type in C: ACK, NACK
tags
TagGroup array
A grouped list of tags containing any additional information sent along with the Acknowledgement.
id
string
Provider-defined ID of the add-on
descriptor
Description of the add-on
price
Price of the add-on
person
Personal details of the agent
contact
Contact details of the agent
organization
The organization details which the agent belongs to
rating
The average user rating of the agent
type
string
Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy.
token
string
Token used for authorization. This is typically generated at the Provider Platform. The Application Platform 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.
valid_from
string
Timestamp in RFC3339 format from which token is valid.
Format: date-time
valid_to
string
Timestamp in RFC3339 format until which token is valid.
Format: date-time
status
string
Status of the token.
name
string
Name of the billable entity
organization
Details of the organization being billed.
address
The address of the billable entity
state
The state where the billable entity resides. This is important for state-level tax calculation
city
The city where the billable entity resides.
string
Email address where the bill is sent to
Format: email
phone
string
Phone number of the billable entity
time
Details regarding the billing period.
tax_id
string
ID of the billable entity as recognized by the taxation authority
time
string
Date-time when the order was cancelled by the buyer
Format: date-time
cancelled_by
string
Enum Data Type in C: CONSUMER, PROVIDER
reason
Option array
The reason for cancellation.
additional_description
Any additional information regarding the nature of cancellation.
fulfillment_state
The state of fulfillment during which this term is applicable. (Fulfillment State)
reason_required
boolean
Indicates whether a reason is required to cancel the order
cancel_by
Information related to the time of cancellation.
cancellation_fee
The cancellation fees levied on the customer
xinput
Form to capture information related to the cancellation
external_ref
Any attachements related to the cancellation
descriptor
Description of the catalog
fulfillments
Fulfillment array
Fulfillment modes offered at the Provider Platform level. This is used when a Provider Platform itself offers fulfillments on behalf of the providers it has aggregated.
payments
Payment array
Payment terms offered by the Provider Platform for all transactions. This can be overriden at the provider level.
offers
Offer array
Offers at the Provider Platform-level. This is usually used when the platform aggregates catalogs of multiple providers
providers
Provider array
Provider of service or product.
exp
string
Timestamp after which catalog will expire
Format: date-time
ttl
string
Duration in seconds after which this catalog will expire
id
string
ID of the category
parent_category_id
ID of the parent category
descriptor
Description of the category
time
Time at or during which this category is valid
ttl
string
Time to live for an instance of this schema
tags
TagGroup array
Array of grouped key value pairs
gps
GPS Co-ordinates of the center
radius
Radius of the circle
name
string
Name of the city
code
string
City code
phone
string
string
jcard
object
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
domain
Industry sector code that is relevant to this transaction
location
The location where the request is restricted to
action
string
The Beckn protocol method being called by the sender and executed at the receiver.
version
string
Version of transaction protocol being used by the sender.
bap_id
string
Subscriber ID of the Application Platform
bap_uri
string
Subscriber URL of the Application Platform for accepting callbacks from Provider Platforms.
bpp_id
string
Subscriber ID of the Provider Platform
bpp_uri
string
Subscriber URL of the Provider Platform for accepting calls from Application Platforms.
transaction_id
string
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 Provider Platforms 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 Application Platform.
Format: uuid
message_id
string
This is a unique value which persists during a request / callback cycle. Since beckn protocol APIs are asynchronous, Application Platforms need a common value to match an incoming callback from a Provider Platform to an earlier call. This value can also be used to ignore duplicate messages coming from the Provider Platform. It is recommended to generate a fresh message_id for every new interaction. When sending unsolicited callbacks, Provider Platforms must generate a new message_id.
Format: uuid
timestamp
string
Time of request generation in RFC3339 format
Format: date-time
key
string
The encryption public key of the sender
ttl
string
The duration in ISO8601 format after timestamp for which this message holds valid
name
string
Name of the country
code
string
Country code as per ISO 3166-1 and ISO 3166-2 format
id
string
type
string
Takes a default value of "VerifiableCredential"
url
string
URL of the credential
Format: uri
person
Personal details of the customer
contact
Contact details of the customer
name
string
Name of the entity being described using this object
code
string
Code of the entity being described using this object
short_desc
string
Short description of the entity being described using this object
long_desc
string
Long description of the entity being described using this object
additional_desc
object
Additional descriptions of the entity being described using this object
media
MediaFile array
Multimedia files describing the entity being described using this object
images
Image array
Image describing the entity being described using this object
name
string
Name of the domain
code
string
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
string
A url that contains addtional information about that domain.
code
string
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
string
Path to json schema generating the error. Used only during json schema validation errors
message
string
Human readable message describing the error. Used mainly for logging. Not recommended to be shown to the user.
percentage
Percentage of order value levied as fee
amount
Value of the fee levied
url
string
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.
Format: uri
data
object
The form submission data
mime_type
string
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.
text/html, application/xml
submission_id
string
Format: uuid
id
string
Unique reference ID to the fulfillment of an order
type
string
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.
rateable
boolean
Whether the fulfillment can be rated or not
rating
The rating value of the fulfullment service.
state
The current state of fulfillment. The Provider Platform must set this value whenever the state of the order fulfillment changes and fire an unsolicited on_status call.
tracking
boolean
Indicates whether the fulfillment allows tracking. Has a default value of false.
customer
the intended recipient of a fulfilled order
agent
The agent that is currently handling the fulfillment of the order
contact
Contact details related to the fulfillment
vehicle
Vehicle used for fulfillment of the order
stops
Stop array
The list of logical stops encountered during the fulfillment of an order.
path
string
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.
tags
TagGroup array
List of grouped key-value pairs to transmit extended metadata related to the fulfillment
descriptor
The description of the current fulfillment state of a confirmed order
updated_at
string
Time at which the state of fulfillment was updated
Format: date-time
updated_by
string
ID of entity which changed the state
url
string
URL to the image. This can be a data url or an remote url
Format: uri
size_type
string
The size of the image. The network policy can define the default dimensions of each type
xs, sm, md, lg, xl, custom
width
string
Width of the image in pixels
height
string
Height of the image in pixels
descriptor
A raw description of the search intent. Free text search strings, raw audio, etc can be sent in this object.
provider
The provider from which the customer wants to place to the order from
fulfillment
Details on how the customer wants their order fulfilled Fulfillment
payment
Details on how the customer wants to pay for the order. Payment
category
Details on the item category
offer
details on the offer the customer wants to avail
item
Details of the item that the consumer wants to order
tags
TagGroup array
allocated
object
This represents the exact quantity allocated for purchase of the item.
available
object
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
maximum
object
This represents the maximum quantity allowed for purchase of the item
minimum
object
This represents the minimum quantity allowed for purchase of the item
selected
object
This represents the quantity selected for purchase of the item
unitized
object
This represents the quantity available in a single unit of the item
id
string
ID of the item.
parent_item_id
string
ID of the item, this item is a variant of
parent_item_quantity
The number of units of the parent item this item is a multiple of
descriptor
Physical description of the item
creator
The creator of this item
price
The price of this item, if it has intrinsic value
quantity
The quantity of the item
category_ids
array
Categories this item can be listed under
fulfillment_ids
array
Modes through which this item can be fulfilled
location_ids
array
Provider Locations this item is available in
payment_ids
array
Payment modalities through which this item can be ordered
add_ons
AddOn array
Add-ons to be included with the item
cancellation_terms
CancellationTerm array
Cancellation terms of this item
refund_terms
RefundTerm array
Refund terms of this item
replacement_terms
ReplacementTerm array
Terms that are applicable be met when this item is replaced Replacement Terms
return_terms
ReturnTerm array
Terms that are applicable when this item is returned Return Terms
xinput
Additional input required from the customer to purchase / avail this item XInput
time
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
rateable
boolean
Whether this item can be rated
rating
The rating of the item
matched
boolean
Whether this item is an exact match of the request
related
boolean
Whether this item is a related item to the exactly matched item
recommended
boolean
Whether this item is a recommended item to a response
ttl
string
Time to live in seconds for an instance of this schema
tags
TagGroup array
Grouped list of extended data regarding the item
id
string
descriptor
Description of the location
map_url
string
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
Format: uri
gps
The GPS co-ordinates of this location.
address
The address of this location.
city
The city this location is, or is located within
district
District
The district this location is, or is located within
state
The state this location is, or is located within
country
The country this location is, or is located within
area_code
string
Area code of the location ex : ZIP code, Pincode etc
circle
Circle that forms the boundary of the location
polygon
string
The boundary polygon of this location
3dspace
string
The three dimensional region describing this location
rating
The rating of this location
mimetype
string
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
url
string
The URL of the file
Format: uri
signature
string
The digital signature of the file signed by the sender
dsa
string
The signing algorithm used by the sender
id
string
descriptor
Description of the offer
location_ids
array
IDs of the Locations this offer is valid in
category_ids
array
IDs of the Categories this offer is valid in
item_ids
array
IDs of the items this offer is valid in
time
Time for which this offer is valid
tags
TagGroup array
Additional metadata related to this offer
id
string
descriptor
Description of the option
id
string
Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.
ref_order_ids
array
A list of order IDs to link this order to previous orders.
status
string
Status of the order. Allowed values can be defined by the network policy
Enum Data Type in C: ACTIVE, COMPLETE, CANCELLED
type
string
This is used to indicate the type of order being created to Provider Platforms. 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. Has a default value of "DEFAULT"
Enum Data Type in C: DRAFT, DEFAULT
provider
Details of the provider whose catalog items have been selected.
items
Items array
The items purchased / availed in this order
add_ons
AddOn array
The add-ons purchased / availed in this order
offers
Offers array
The offers applied in this order
billing
Billing array
The billing details of this order
fulfillments
Fulfillment array
The fulfillments involved in completing this order
cancellation
The cancellation details of this order
cancellation_terms
CancellationTerm array
Cancellation terms of this item
refund_terms
RefundTerm array
Refund terms of this item
replacement_terms
ReplacementTerm array
Replacement terms of this item
return_terms
ReturnTerm array
Return terms of this item
quote
The mutually agreed upon quotation for this order.
payments
Payment array
The terms of settlement for this order
created_at
string
The date-time of creation of this order
Format: date-time
updated_at
string
The date-time of updated of this order
Format: date-time
xinput
Additional input required from the customer to confirm this order
tags
TagGroup array
Grouped list of extended metadata related to the Order
descriptor
Description of the organization
address
The postal address of the organization
state
The state where the the organization's address is registered
city
The city where the the organization's address is registered
contact
Contact details of the organization
id
string
collected_by
url
string
Format: uri
uri
params
object
type
string
PRE-ORDER, PRE-FULFILLMENT, ON-FULFILLMENT, POST-FULFILLMENT
status
string
PAID, NOT-PAID
time
Temporal details related to the settlement of the order
tags
TagGroup array
Grouped list of metadata related to the settlement of the order
id
string
Describes the identity of the person
url
string
Profile url of the person
Format: uri
name
string
the name of the person
image
age
Age of the person
dob
string
Date of birth of the person
Format: date
gender
string
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
Credential array
List of the person's credentials
languages
array
skills
array
tags
TagGroup array
Grouped list containing extended metadata about the person
currency
string
value
Default value of the Item price
estimated_value
Estimated value of an Item price
computed_value
Computed value of an Item price
listed_value
Listed value of an Item price
offered_value
Offered value of an Item price
minimum_value
Minimum value of an Item price
maximum_value
Maximum value of an Item price
id
string
Id of the provider
descriptor
Description of the provider
category_id
string
Category Id of the provider at the Provider Platform-level catalog
rating
Rating of the provider
time
Time during which the catalog is available
categories
Category array
Categories in the catalog
fulfillments
Fulfillment array
List of fulfillment terms of the provider
payments
Payment array
List of payment terms of the provider
locations
Location array
Locations where the provider can be accessed
offers
Offer array
Offers listed by the provider
items
Item array
Items cataloged by the provider
exp
string
Time after which catalog has to be refreshed
Format: date-time
rateable
boolean
Whether this provider can be rated or not
ttl
integer
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.
tags
TagGroup array
Grouped metadata related to the provider
id
string
ID of the quote.
Format: uuid
price
The total quoted price
breakup
array
the breakup of the total quoted price
ttl
Duration for which the quotation is valid
rating_category
string
Category of the entity being rated
Enum Data Type in C: Item, Order, Fulfillment, Provider, Agent, Support
id
string
Id of the object being rated
value
string
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
.
dimensions
string
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.
Enum Data Type in C: 1, 2, 3
type
string
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.
name
string
Name of the region as specified on the map where that region exists.
code
string
A standard code representing the region. This should be interpreted in the same way by all network participants.
boundary
string
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
string
The url to the map of the region. This can be a globally recognized map or the one specified by the network policy.
fulfillment_state
FulfillmentState array
The state of fulfillment during which this term is applicable.
replace_within
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.
external_ref
Any file containing info related to the terms
fulfillment_state
FulfillmentState array
The state of fulfillment during which this term IETF''s applicable.
return_eligible
boolean
Indicates whether the item is eligible for return
return_time
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.
return_location
The location where the item or order must / will be returned to
fulfillment_managed_by
string
The entity that will perform the return
Enum Data Type in C: CONSUMER, PROVIDER
type
string
Enum Data Type in C: CONSTANT, VARIABLE
value
Default value
estimated_value
Estimated value
computed_value
Computed value
range
Range of values
unit
string
unit of value
frequency
Frequency of recurrence
holidays
array
Holidays
times
Time array
Time slots
name
string
Name of the state
code
string
State code as per country or international standards
id
string
parent_stop_id
string
location
Location of the stop
type
string
The type of stop. Allowed values of this property can be defined by the network policy.
time
Timings applicable at the stop.
instructions
Descriptor array
Instructions that need to be followed at the stop
contact
Contact details of the stop
person
The details of the person present at the stop
authorization
Authorization details required to commence this leg of fulfillment
ref_id
string
callback_phone
string
Format: phone
phone
string
Format: phone
string
Format: email
url
string
Format: uri
descriptor
Description of the Tag, can be used to store detailed information.
value
string
The value of the tag. This set by the Provider Platform and rendered as-is by the Application Platform.
display
boolean
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.
display
boolean
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. Has a default value of true.
descriptor
Description of the TagGroup, can be used to store detailed information.
list
array
An array of Tag objects listed under this group. This property can be set by Application Platforms during search to narrow the search and achieve more relevant results. When received during on_search, Application Platforms must render this list under the heading described by the name property of this schema.
label
string
timestamp
string
Format: date-time
duration
Duration between two instances of time
range
object
days
string
comma separated values representing days of the week
schedule
schedule
id
string
A unique tracking reference number
url
string
A URL to the tracking endpoint. This can be a link to a tracking webpage, a webhook URL created by the Application Platform where Provider Platform can push the tracking data, or a GET url creaed by the Provider Platform which the Application Platform can poll to get the tracking data. It can also be a websocket URL where the Provider Platform can push real-time tracking data.
uri
location
In case there is no real-time tracking endpoint available, this field will contain the latest location of the entity being tracked. The Provider Platform will update this value everytime the Application Platform calls the track API.
status
string
This value indicates if the tracking is currently active or not. If this value is active, then the Application Platform can begin tracking the order. If this value is inactive, the tracking URL is considered to be expired and the Application Platform should stop tracking the order.
active, inactive
category
string
capacity
integer
make
string
model
string
size
string
variant
string
color
string
energy_type
string
registration
string
wheels_count
string
cargo_volumne
string
wheelchair_access
string
code
string
emission_standard
string
form
Form details to capture input
required
boolean
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
head
object
Form headers
