Since inventory is a provider-centric feature, it does not interface with a customer. However, it is called by other services like quotation management, order management, and fulfillment management services.
Consumer Interface declares the customer's intent to buy/avail products or services
Domain code that is relevant to this transaction context
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.
The location where the transaction is intended to be fulfilled.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The Beckn protocol method being called by the sender and executed at the receiver.
Version of transaction protocol being used by the sender.
Subscriber ID of the Consumer Interface
A globally unique identifier of the platform, Typically it is the fully qualified domain name (FQDN) of the platform.
Subscriber URL of the Consumer Interface for accepting callbacks from Provider Platforms.
The callback URL of the Subscriber. This should necessarily contain the same domain name as set in `subscriber_id``.
Subscriber ID of the Provider Platform
A globally unique identifier of the platform, Typically it is the fully qualified domain name (FQDN) of the platform.
Subscriber URL of the Provider Platform for accepting calls from Consumer Interfaces.
The callback URL of the Subscriber. This should necessarily contain the same domain name as set in `subscriber_id``.
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 Consumer Interface.
This is a unique value which persists during a request / callback cycle. Since beckn protocol APIs are asynchronous, Consumer Interfaces 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.
Time of request generation in RFC3339 format
The encryption public key of the sender
The duration in ISO8601 format after timestamp for which this message holds valid
The intent to buy or avail a product or a service. The Consumer Interface 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 fromWhen they want it (start and end time of fulfillmentHow they want to pay for itThis has properties like descriptor,provider,fulfillment,payment,category,offer,item,tagsThis is typically used by the Consumer Interface 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 availWhat 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 carryingHow 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)
A raw description of the search intent. Free text search strings, raw audio, etc can be sent in this object.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The provider from which the customer wants to place to the order from
Id of the provider
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Category Id of the provider at the Provider Platform-level catalog
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 ||.
Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operationsThis has properties like label, time stamp,duration,range, days, schedule
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
ID of the category
ID of the category
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operationsThis has properties like label, time stamp,duration,range, days, schedule
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Time to live for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Unique reference ID to the fulfillment of an order
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.
Whether the fulfillment can be rated or not
The rating value of the fulfullment service.
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 ||.
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.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether the fulfillment allows tracking
The person that will ultimately receive the order
Describes a person as any individual
Describes the identity of the person
Profile url of the person
the name of the person
Describes an image
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Age of the person
Describes duration as per ISO8601 format
Date of birth of the person
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
URL of the credential
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The agent that is currently handling the fulfillment of the order
Describes a person as any individual
Describes the identity of the person
Profile url of the person
the name of the person
Describes an image
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Age of the person
Describes duration as per ISO8601 format
Date of birth of the person
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
URL of the credential
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
An organization. Usually a recognized business entity.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
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 ||.
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
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
The list of logical stops encountered during the fulfillment of an order.
Location of the stop
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The type of stop. Allowed values of this property can be defined by the network policy.
Timings applicable at the stop.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Instructions that need to be followed at the stop
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Contact details of the stop
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The details of the person present at the stop
Describes the identity of the person
Profile url of the person
the name of the person
Describes an image
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Age of the person
Describes duration as per ISO8601 format
Date of birth of the person
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
URL of the credential
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
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 of authorization mechanism used. The allowed values for this field can be published as part of the network policy.
Token used for authorization. This is typically generated at the Provider Platform. The Consumer Interface 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.
Timestamp in RFC3339 format from which token is valid
Timestamp in RFC3339 format until which token is valid
Status of the token
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.
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
ID of the payment term that can be referred at an item or an order level in a catalog
This field indicates who is the collector of payment. The Consumer Interface can set this value to 'Consumer Interface' if it wants to collect the payment first and settle it to the Provider Platform. If the Provider Platform agrees to those terms, the Provider Platform should not send the payment url. Alternatively, the Provider Platform can set this field with the value 'Provider Platform' if it wants the payment to be made directly.
A payment url to be called by the Consumer Interface. 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.
The reference transaction ID associated with a payment activity
Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operationsThis has properties like label, time stamp,duration,range, days, schedule
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of the category
ID of the item.
Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operationsThis has properties like label, time stamp,duration,range, days, schedule
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
ID of the item.
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Physical description of the item
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The creator of this item
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The price of this item, if it has intrinsic value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The selling quantity of the item
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Categories this item can be listed under
ID of the category
Modes through which this item can be fulfilled
Unique reference ID to the fulfillment of an order
Provider Locations this item is available in
Payment modalities through which this item can be ordered
ID of the payment term that can be referred at an item or an order level in a catalog
Provider-defined ID of the add-on
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Cancellation terms of this item
The state of fulfillment during which this term is applicable.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether a reason is required to cancel the order
Information related to the time of cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
A fee applied on a particular entity
Percentage of a value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
A fixed value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
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 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, 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 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 Consumer Interface must render a separate form for the Item and another form at the Order level before confirmation.
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Refund terms of this item
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
Indicates if cancellation will result in a refund
Time within which refund will be processed after successful cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Terms that are applicable be met when this item is replaced
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
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
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Terms that are applicable when this item is returned
The state of fulfillment during which this term IETF''s applicable.
Name of the state
State code as per country or international standards
Indicates whether the item is eligible for return
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.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
The location where the item or order must / will be returned to
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The entity that will perform the return
Additional input required from the customer to purchase / avail this item
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Whether this item can be rated
The rating of the item
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 ||.
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Time after which catalog has to be refreshed
Whether this provider can be rated or not
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.
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Details on how the customer wants their order fulfilled
Unique reference ID to the fulfillment of an order
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.
Whether the fulfillment can be rated or not
The rating value of the fulfullment service.
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 ||.
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.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether the fulfillment allows tracking
The person that will ultimately receive the order
Describes a person as any individual
Describes the identity of the person
Profile url of the person
the name of the person
Describes an image
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Age of the person
Describes duration as per ISO8601 format
Date of birth of the person
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
URL of the credential
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The agent that is currently handling the fulfillment of the order
Describes a person as any individual
Describes the identity of the person
Profile url of the person
the name of the person
Describes an image
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Age of the person
Describes duration as per ISO8601 format
Date of birth of the person
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
URL of the credential
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
An organization. Usually a recognized business entity.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
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 ||.
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
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
The list of logical stops encountered during the fulfillment of an order.
Location of the stop
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The type of stop. Allowed values of this property can be defined by the network policy.
Timings applicable at the stop.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Instructions that need to be followed at the stop
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Contact details of the stop
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The details of the person present at the stop
Describes the identity of the person
Profile url of the person
the name of the person
Describes an image
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Age of the person
Describes duration as per ISO8601 format
Date of birth of the person
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
URL of the credential
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
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 of authorization mechanism used. The allowed values for this field can be published as part of the network policy.
Token used for authorization. This is typically generated at the Provider Platform. The Consumer Interface 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.
Timestamp in RFC3339 format from which token is valid
Timestamp in RFC3339 format until which token is valid
Status of the token
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.
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Details on how the customer wants to pay for the order
ID of the payment term that can be referred at an item or an order level in a catalog
This field indicates who is the collector of payment. The Consumer Interface can set this value to 'Consumer Interface' if it wants to collect the payment first and settle it to the Provider Platform. If the Provider Platform agrees to those terms, the Provider Platform should not send the payment url. Alternatively, the Provider Platform can set this field with the value 'Provider Platform' if it wants the payment to be made directly.
A payment url to be called by the Consumer Interface. 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.
The reference transaction ID associated with a payment activity
Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operationsThis has properties like label, time stamp,duration,range, days, schedule
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Details on the item category
ID of the category
ID of the category
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operationsThis has properties like label, time stamp,duration,range, days, schedule
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Time to live for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
details on the offer the customer wants to avail
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of the category
ID of the item.
Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operationsThis has properties like label, time stamp,duration,range, days, schedule
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Details of the item that the consumer wants to order
ID of the item.
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Physical description of the item
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The creator of this item
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The price of this item, if it has intrinsic value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The selling quantity of the item
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Categories this item can be listed under
ID of the category
Modes through which this item can be fulfilled
Unique reference ID to the fulfillment of an order
Provider Locations this item is available in
Payment modalities through which this item can be ordered
ID of the payment term that can be referred at an item or an order level in a catalog
Provider-defined ID of the add-on
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Cancellation terms of this item
The state of fulfillment during which this term is applicable.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether a reason is required to cancel the order
Information related to the time of cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
A fee applied on a particular entity
Percentage of a value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
A fixed value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
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 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, 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 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 Consumer Interface must render a separate form for the Item and another form at the Order level before confirmation.
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Refund terms of this item
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
Indicates if cancellation will result in a refund
Time within which refund will be processed after successful cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Terms that are applicable be met when this item is replaced
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
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
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Terms that are applicable when this item is returned
The state of fulfillment during which this term IETF''s applicable.
Name of the state
State code as per country or international standards
Indicates whether the item is eligible for return
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.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
The location where the item or order must / will be returned to
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The entity that will perform the return
Additional input required from the customer to purchase / avail this item
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Whether this item can be rated
The rating of the item
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 ||.
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Acknowledgement of message received after successful validation of schema and signature
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 Provider Platform must be responded to with an Ack whether the Provider Platform intends to respond with a callback or not. This has one property called status
that indicates the status of the Acknowledgement.
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
.
A list of tags containing any additional information sent along with the Acknowledgement.
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Describes an error object that is returned by a Consumer Interface, 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.
Standard error code. For full list of error codes, refer to docs/protocol-drafts/BECKN-005-ERROR-CODES-DRAFT-01.md of this repo"
Path to json schema generating the error. Used only during json schema validation errors
Human readable message describing the error. Used mainly for logging. Not recommended to be shown to the user.
Check availability of a resource in an inventory
Name of the resource
ID of the Resource
ID of the item.
Successful fetch of resources from the catalog
ID of the item.
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Physical description of the item
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The creator of this item
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The price of this item, if it has intrinsic value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The selling quantity of the item
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Categories this item can be listed under
ID of the category
Modes through which this item can be fulfilled
Unique reference ID to the fulfillment of an order
Provider Locations this item is available in
Payment modalities through which this item can be ordered
ID of the payment term that can be referred at an item or an order level in a catalog
Provider-defined ID of the add-on
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Cancellation terms of this item
The state of fulfillment during which this term is applicable.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether a reason is required to cancel the order
Information related to the time of cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
A fee applied on a particular entity
Percentage of a value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
A fixed value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
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 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, 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 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 Consumer Interface must render a separate form for the Item and another form at the Order level before confirmation.
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Refund terms of this item
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
Indicates if cancellation will result in a refund
Time within which refund will be processed after successful cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Terms that are applicable be met when this item is replaced
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
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
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Terms that are applicable when this item is returned
The state of fulfillment during which this term IETF''s applicable.
Name of the state
State code as per country or international standards
Indicates whether the item is eligible for return
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.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
The location where the item or order must / will be returned to
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The entity that will perform the return
Additional input required from the customer to purchase / avail this item
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Whether this item can be rated
The rating of the item
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 ||.
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Add Item to inventory
ID of the item.
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Physical description of the item
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The creator of this item
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The price of this item, if it has intrinsic value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The selling quantity of the item
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Categories this item can be listed under
ID of the category
Modes through which this item can be fulfilled
Unique reference ID to the fulfillment of an order
Provider Locations this item is available in
Payment modalities through which this item can be ordered
ID of the payment term that can be referred at an item or an order level in a catalog
Provider-defined ID of the add-on
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Cancellation terms of this item
The state of fulfillment during which this term is applicable.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether a reason is required to cancel the order
Information related to the time of cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
A fee applied on a particular entity
Percentage of a value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
A fixed value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
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 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, 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 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 Consumer Interface must render a separate form for the Item and another form at the Order level before confirmation.
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Refund terms of this item
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
Indicates if cancellation will result in a refund
Time within which refund will be processed after successful cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Terms that are applicable be met when this item is replaced
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
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
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Terms that are applicable when this item is returned
The state of fulfillment during which this term IETF''s applicable.
Name of the state
State code as per country or international standards
Indicates whether the item is eligible for return
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.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
The location where the item or order must / will be returned to
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The entity that will perform the return
Additional input required from the customer to purchase / avail this item
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Whether this item can be rated
The rating of the item
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 ||.
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Successful fetch of resources from the catalog
ID of the item.
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Physical description of the item
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The creator of this item
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The price of this item, if it has intrinsic value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The selling quantity of the item
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Categories this item can be listed under
ID of the category
Modes through which this item can be fulfilled
Unique reference ID to the fulfillment of an order
Provider Locations this item is available in
Payment modalities through which this item can be ordered
ID of the payment term that can be referred at an item or an order level in a catalog
Provider-defined ID of the add-on
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Cancellation terms of this item
The state of fulfillment during which this term is applicable.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether a reason is required to cancel the order
Information related to the time of cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
A fee applied on a particular entity
Percentage of a value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
A fixed value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
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 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, 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 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 Consumer Interface must render a separate form for the Item and another form at the Order level before confirmation.
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Refund terms of this item
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
Indicates if cancellation will result in a refund
Time within which refund will be processed after successful cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Terms that are applicable be met when this item is replaced
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
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
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Terms that are applicable when this item is returned
The state of fulfillment during which this term IETF''s applicable.
Name of the state
State code as per country or international standards
Indicates whether the item is eligible for return
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.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
The location where the item or order must / will be returned to
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The entity that will perform the return
Additional input required from the customer to purchase / avail this item
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Whether this item can be rated
The rating of the item
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 ||.
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Remove Item from inventory
ID of the item.
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Physical description of the item
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The creator of this item
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The price of this item, if it has intrinsic value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The selling quantity of the item
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Categories this item can be listed under
ID of the category
Modes through which this item can be fulfilled
Unique reference ID to the fulfillment of an order
Provider Locations this item is available in
Payment modalities through which this item can be ordered
ID of the payment term that can be referred at an item or an order level in a catalog
Provider-defined ID of the add-on
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Cancellation terms of this item
The state of fulfillment during which this term is applicable.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether a reason is required to cancel the order
Information related to the time of cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
A fee applied on a particular entity
Percentage of a value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
A fixed value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
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 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, 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 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 Consumer Interface must render a separate form for the Item and another form at the Order level before confirmation.
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Refund terms of this item
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
Indicates if cancellation will result in a refund
Time within which refund will be processed after successful cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Terms that are applicable be met when this item is replaced
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
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
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Terms that are applicable when this item is returned
The state of fulfillment during which this term IETF''s applicable.
Name of the state
State code as per country or international standards
Indicates whether the item is eligible for return
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.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
The location where the item or order must / will be returned to
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The entity that will perform the return
Additional input required from the customer to purchase / avail this item
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Whether this item can be rated
The rating of the item
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 ||.
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Successful fetch of resources from the catalog
ID of the item.
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Physical description of the item
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The creator of this item
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The price of this item, if it has intrinsic value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The selling quantity of the item
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Categories this item can be listed under
ID of the category
Modes through which this item can be fulfilled
Unique reference ID to the fulfillment of an order
Provider Locations this item is available in
Payment modalities through which this item can be ordered
ID of the payment term that can be referred at an item or an order level in a catalog
Provider-defined ID of the add-on
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Cancellation terms of this item
The state of fulfillment during which this term is applicable.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether a reason is required to cancel the order
Information related to the time of cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
A fee applied on a particular entity
Percentage of a value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
A fixed value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
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 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, 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 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 Consumer Interface must render a separate form for the Item and another form at the Order level before confirmation.
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Refund terms of this item
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
Indicates if cancellation will result in a refund
Time within which refund will be processed after successful cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Terms that are applicable be met when this item is replaced
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
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
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Terms that are applicable when this item is returned
The state of fulfillment during which this term IETF''s applicable.
Name of the state
State code as per country or international standards
Indicates whether the item is eligible for return
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.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
The location where the item or order must / will be returned to
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The entity that will perform the return
Additional input required from the customer to purchase / avail this item
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Whether this item can be rated
The rating of the item
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 ||.
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Block Item in inventory
ID of the item.
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Physical description of the item
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The creator of this item
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The price of this item, if it has intrinsic value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The selling quantity of the item
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Categories this item can be listed under
ID of the category
Modes through which this item can be fulfilled
Unique reference ID to the fulfillment of an order
Provider Locations this item is available in
Payment modalities through which this item can be ordered
ID of the payment term that can be referred at an item or an order level in a catalog
Provider-defined ID of the add-on
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Cancellation terms of this item
The state of fulfillment during which this term is applicable.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether a reason is required to cancel the order
Information related to the time of cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
A fee applied on a particular entity
Percentage of a value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
A fixed value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
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 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, 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 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 Consumer Interface must render a separate form for the Item and another form at the Order level before confirmation.
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Refund terms of this item
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
Indicates if cancellation will result in a refund
Time within which refund will be processed after successful cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Terms that are applicable be met when this item is replaced
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
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
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Terms that are applicable when this item is returned
The state of fulfillment during which this term IETF''s applicable.
Name of the state
State code as per country or international standards
Indicates whether the item is eligible for return
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.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
The location where the item or order must / will be returned to
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The entity that will perform the return
Additional input required from the customer to purchase / avail this item
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Whether this item can be rated
The rating of the item
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 ||.
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Successful fetch of resources from the catalog
ID of the item.
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Physical description of the item
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The creator of this item
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The price of this item, if it has intrinsic value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The selling quantity of the item
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Categories this item can be listed under
ID of the category
Modes through which this item can be fulfilled
Unique reference ID to the fulfillment of an order
Provider Locations this item is available in
Payment modalities through which this item can be ordered
ID of the payment term that can be referred at an item or an order level in a catalog
Provider-defined ID of the add-on
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Cancellation terms of this item
The state of fulfillment during which this term is applicable.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether a reason is required to cancel the order
Information related to the time of cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
A fee applied on a particular entity
Percentage of a value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
A fixed value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
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 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, 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 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 Consumer Interface must render a separate form for the Item and another form at the Order level before confirmation.
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Refund terms of this item
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
Indicates if cancellation will result in a refund
Time within which refund will be processed after successful cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Terms that are applicable be met when this item is replaced
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
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
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Terms that are applicable when this item is returned
The state of fulfillment during which this term IETF''s applicable.
Name of the state
State code as per country or international standards
Indicates whether the item is eligible for return
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.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
The location where the item or order must / will be returned to
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The entity that will perform the return
Additional input required from the customer to purchase / avail this item
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Whether this item can be rated
The rating of the item
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 ||.
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Unblock addOn in inventory
ID of the item.
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Physical description of the item
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The creator of this item
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The price of this item, if it has intrinsic value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The selling quantity of the item
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Categories this item can be listed under
ID of the category
Modes through which this item can be fulfilled
Unique reference ID to the fulfillment of an order
Provider Locations this item is available in
Payment modalities through which this item can be ordered
ID of the payment term that can be referred at an item or an order level in a catalog
Provider-defined ID of the add-on
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Cancellation terms of this item
The state of fulfillment during which this term is applicable.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether a reason is required to cancel the order
Information related to the time of cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
A fee applied on a particular entity
Percentage of a value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
A fixed value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
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 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, 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 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 Consumer Interface must render a separate form for the Item and another form at the Order level before confirmation.
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Refund terms of this item
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
Indicates if cancellation will result in a refund
Time within which refund will be processed after successful cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Terms that are applicable be met when this item is replaced
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
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
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Terms that are applicable when this item is returned
The state of fulfillment during which this term IETF''s applicable.
Name of the state
State code as per country or international standards
Indicates whether the item is eligible for return
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.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
The location where the item or order must / will be returned to
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The entity that will perform the return
Additional input required from the customer to purchase / avail this item
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Whether this item can be rated
The rating of the item
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 ||.
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Successful fetch of resources from the catalog
ID of the item.
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Physical description of the item
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The creator of this item
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The price of this item, if it has intrinsic value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The selling quantity of the item
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Categories this item can be listed under
ID of the category
Modes through which this item can be fulfilled
Unique reference ID to the fulfillment of an order
Provider Locations this item is available in
Payment modalities through which this item can be ordered
ID of the payment term that can be referred at an item or an order level in a catalog
Provider-defined ID of the add-on
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Cancellation terms of this item
The state of fulfillment during which this term is applicable.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether a reason is required to cancel the order
Information related to the time of cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
A fee applied on a particular entity
Percentage of a value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
A fixed value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
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 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, 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 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 Consumer Interface must render a separate form for the Item and another form at the Order level before confirmation.
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Refund terms of this item
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
Indicates if cancellation will result in a refund
Time within which refund will be processed after successful cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Terms that are applicable be met when this item is replaced
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
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
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Terms that are applicable when this item is returned
The state of fulfillment during which this term IETF''s applicable.
Name of the state
State code as per country or international standards
Indicates whether the item is eligible for return
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.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
The location where the item or order must / will be returned to
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The entity that will perform the return
Additional input required from the customer to purchase / avail this item
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Whether this item can be rated
The rating of the item
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 ||.
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Block add-on in inventory
ID of the item.
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Physical description of the item
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The creator of this item
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The price of this item, if it has intrinsic value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The selling quantity of the item
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Categories this item can be listed under
ID of the category
Modes through which this item can be fulfilled
Unique reference ID to the fulfillment of an order
Provider Locations this item is available in
Payment modalities through which this item can be ordered
ID of the payment term that can be referred at an item or an order level in a catalog
Provider-defined ID of the add-on
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Cancellation terms of this item
The state of fulfillment during which this term is applicable.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether a reason is required to cancel the order
Information related to the time of cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
A fee applied on a particular entity
Percentage of a value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
A fixed value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
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 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, 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 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 Consumer Interface must render a separate form for the Item and another form at the Order level before confirmation.
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Refund terms of this item
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
Indicates if cancellation will result in a refund
Time within which refund will be processed after successful cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Terms that are applicable be met when this item is replaced
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
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
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Terms that are applicable when this item is returned
The state of fulfillment during which this term IETF''s applicable.
Name of the state
State code as per country or international standards
Indicates whether the item is eligible for return
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.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
The location where the item or order must / will be returned to
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The entity that will perform the return
Additional input required from the customer to purchase / avail this item
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Whether this item can be rated
The rating of the item
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 ||.
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Successful fetch of resources from the catalog
ID of the item.
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Physical description of the item
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The creator of this item
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The price of this item, if it has intrinsic value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The selling quantity of the item
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Categories this item can be listed under
ID of the category
Modes through which this item can be fulfilled
Unique reference ID to the fulfillment of an order
Provider Locations this item is available in
Payment modalities through which this item can be ordered
ID of the payment term that can be referred at an item or an order level in a catalog
Provider-defined ID of the add-on
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Cancellation terms of this item
The state of fulfillment during which this term is applicable.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether a reason is required to cancel the order
Information related to the time of cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
A fee applied on a particular entity
Percentage of a value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
A fixed value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
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 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, 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 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 Consumer Interface must render a separate form for the Item and another form at the Order level before confirmation.
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Refund terms of this item
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
Indicates if cancellation will result in a refund
Time within which refund will be processed after successful cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Terms that are applicable be met when this item is replaced
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
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
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Terms that are applicable when this item is returned
The state of fulfillment during which this term IETF''s applicable.
Name of the state
State code as per country or international standards
Indicates whether the item is eligible for return
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.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
The location where the item or order must / will be returned to
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The entity that will perform the return
Additional input required from the customer to purchase / avail this item
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Whether this item can be rated
The rating of the item
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 ||.
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Add Item to inventory
ID of the item.
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Physical description of the item
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The creator of this item
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The price of this item, if it has intrinsic value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The selling quantity of the item
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Categories this item can be listed under
ID of the category
Modes through which this item can be fulfilled
Unique reference ID to the fulfillment of an order
Provider Locations this item is available in
Payment modalities through which this item can be ordered
ID of the payment term that can be referred at an item or an order level in a catalog
Provider-defined ID of the add-on
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Cancellation terms of this item
The state of fulfillment during which this term is applicable.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether a reason is required to cancel the order
Information related to the time of cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
A fee applied on a particular entity
Percentage of a value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
A fixed value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
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 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, 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 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 Consumer Interface must render a separate form for the Item and another form at the Order level before confirmation.
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Refund terms of this item
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
Indicates if cancellation will result in a refund
Time within which refund will be processed after successful cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Terms that are applicable be met when this item is replaced
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
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
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Terms that are applicable when this item is returned
The state of fulfillment during which this term IETF''s applicable.
Name of the state
State code as per country or international standards
Indicates whether the item is eligible for return
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.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
The location where the item or order must / will be returned to
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The entity that will perform the return
Additional input required from the customer to purchase / avail this item
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Whether this item can be rated
The rating of the item
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 ||.
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.
Successful fetch of resources from the catalog
ID of the item.
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Physical description of the item
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The creator of this item
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The price of this item, if it has intrinsic value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The selling quantity of the item
This represents the exact quantity allocated for purchase of the item.
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the exact quantity available for purchase of the item. The buyer can only purchase multiples of this
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the maximum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the minimum quantity allowed for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity selected for purchase of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
This represents the quantity available in a single unit of the item
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Categories this item can be listed under
ID of the category
Modes through which this item can be fulfilled
Unique reference ID to the fulfillment of an order
Provider Locations this item is available in
Payment modalities through which this item can be ordered
ID of the payment term that can be referred at an item or an order level in a catalog
Provider-defined ID of the add-on
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Cancellation terms of this item
The state of fulfillment during which this term is applicable.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether a reason is required to cancel the order
Information related to the time of cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
A fee applied on a particular entity
Percentage of a value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
A fixed value
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
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 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, 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 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 Consumer Interface must render a separate form for the Item and another form at the Order level before confirmation.
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Refund terms of this item
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
Indicates if cancellation will result in a refund
Time within which refund will be processed after successful cancellation.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Describes the price of a product or service
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Terms that are applicable be met when this item is replaced
The state of fulfillment during which this term is applicable.
Name of the state
State code as per country or international standards
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
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
This object contains a url to a media file.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
Terms that are applicable when this item is returned
The state of fulfillment during which this term IETF''s applicable.
Name of the state
State code as per country or international standards
Indicates whether the item is eligible for return
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.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
The location where the item or order must / will be returned to
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+
The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
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 ||.
The entity that will perform the return
Additional input required from the customer to purchase / avail this item
Describes a form
ID of the form
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.
The form submission data
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.
Describes a form
ID of the form
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.
The form submission data
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.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes duration as per ISO8601 format
comma separated values representing days of the week
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
Describes duration as per ISO8601 format
Whether this item can be rated
The rating of the item
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 ||.
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search
and achieve more relevant results. When received during on_search
, Consumer Interfaces must render this list under the heading described by the name
property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
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.