8.1 Catalog Management
Last updated
Was this helpful?
Last updated
Was this helpful?
Platform Administration APIs consist of all the endpoints that are used to provide user experience and manage the business workflows like catalog management, cart management, checkout, terms management, content management, etc. These follow REST Standards for the creation, read, update, and deletion of objects in the database.
Update a resource to the catalog
Name of the resource
ID of the Resource
Id of the provider
Unique reference ID to the fulfillment of an order
ID of the category
ID of the payment term that can be referred at an item or an order level in a catalog
Describes the catalog of a business.
Describes how a an order will be rendered/fulfilled to the end-customer
A label under which a collection of items can be grouped.
Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.
Describes the terms of settlement between the Consumer Interface and the Provider Platform for a single transaction. When instantiated, this object contains the amount that has to be settled,The payment destination destination detailsWhen the settlement should happen, andA transaction reference ID. During a transaction, the Provider Platform reserves the right to decide the terms of payment. However, the Consumer Interface can send its terms to the Provider Platform first. If the Provider Platform does not agree to those terms, it must overwrite the terms and return them to the Consumer Interface. If overridden, the Consumer Interface must either agree to the terms sent by the Provider Platform in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the Consumer Interface and the Provider Platform can perform offline negotiations on the payment terms. Once an agreement is reached, the Consumer Interface and Provider Platform can resume transactions.
DELETE /beckn/e-marketplace-bb/0.2/catalog/{resource}/{id} HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
Successful fetch of resources from the catalog
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"category_id": "text",
"rating": "text",
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"categories": [
{
"id": "text",
"parent_category_id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "text",
"type": "text",
"rateable": true,
"rating": "text",
"state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"tracking": true,
"customer": {
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-04-24",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"agent": {
"id": "text",
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-04-24",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"organization": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"rating": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"vehicle": {
"category": "text",
"capacity": 1,
"make": "text",
"model": "text",
"size": "text",
"variant": "text",
"color": "text",
"energy_type": "text",
"registration": "text",
"wheels_count": "text",
"cargo_volumne": "text",
"wheelchair_access": "text",
"code": "text",
"emission_standard": "text"
},
"stops": [
{
"id": "text",
"parent_stop_id": "text",
"location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"type": "text",
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"instructions": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-04-24",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"authorization": {
"type": "text",
"token": "text",
"valid_from": "2025-04-24T07:40:44.542Z",
"valid_to": "2025-04-24T07:40:44.542Z",
"status": "text"
}
}
],
"path": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
],
"payments": [
{
"id": "text",
"collected_by": null,
"url": "https://example.com",
"params": {
"transaction_id": "text",
"amount": "text",
"currency": "text",
"bank_code": "text",
"bank_account_number": "text",
"virtual_payment_address": "text",
"source_bank_code": "text",
"source_bank_account_number": "text",
"source_virtual_payment_address": "text"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
],
"locations": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
}
],
"offers": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"location_ids": [
"text"
],
"category_ids": [
"text"
],
"item_ids": [
"text"
],
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
],
"items": [
{
"id": "text",
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"cancellation_terms": [
{
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"reason_required": true,
"cancel_by": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"cancellation_fee": {
"percentage": "text",
"amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
},
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"refund_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_eligible": true,
"refund_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"replacement_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"return_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_eligible": true,
"return_time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"rateable": true,
"rating": "text",
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
],
"exp": "2025-04-24T07:40:44.542Z",
"rateable": true,
"ttl": 1,
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
Find catalog
Id of the provider
Name of the resource
ID of the resource in the provider's catalog
ID of the item.
Unique reference ID to the fulfillment of an order
ID of the category
ID of the payment term that can be referred at an item or an order level in a catalog
Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.
The physical location of something
Describes how a an order will be rendered/fulfilled to the end-customer
A label under which a collection of items can be grouped.
Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.
Describes the terms of settlement between the Consumer Interface and the Provider Platform for a single transaction. When instantiated, this object contains the amount that has to be settled,The payment destination destination detailsWhen the settlement should happen, andA transaction reference ID. During a transaction, the Provider Platform reserves the right to decide the terms of payment. However, the Consumer Interface can send its terms to the Provider Platform first. If the Provider Platform does not agree to those terms, it must overwrite the terms and return them to the Consumer Interface. If overridden, the Consumer Interface must either agree to the terms sent by the Provider Platform in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the Consumer Interface and the Provider Platform can perform offline negotiations on the payment terms. Once an agreement is reached, the Consumer Interface and Provider Platform can resume transactions.
GET /beckn/e-marketplace-bb/0.2/catalog/provider/{providerId}/{resource}/{id} HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
Successful fetch of resources from the catalog
{
"id": "text",
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"cancellation_terms": [
{
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"reason_required": true,
"cancel_by": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"cancellation_fee": {
"percentage": "text",
"amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
},
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"refund_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_eligible": true,
"refund_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"replacement_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"return_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_eligible": true,
"return_time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"rateable": true,
"rating": "text",
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
Update a resource to the catalog
Id of the provider
Name of the resource
ID of the resource in the provider's catalog
ID of the item.
Unique reference ID to the fulfillment of an order
ID of the category
ID of the payment term that can be referred at an item or an order level in a catalog
Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.
The physical location of something
Describes how a an order will be rendered/fulfilled to the end-customer
A label under which a collection of items can be grouped.
Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.
Describes the terms of settlement between the Consumer Interface and the Provider Platform for a single transaction. When instantiated, this object contains the amount that has to be settled,The payment destination destination detailsWhen the settlement should happen, andA transaction reference ID. During a transaction, the Provider Platform reserves the right to decide the terms of payment. However, the Consumer Interface can send its terms to the Provider Platform first. If the Provider Platform does not agree to those terms, it must overwrite the terms and return them to the Consumer Interface. If overridden, the Consumer Interface must either agree to the terms sent by the Provider Platform in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the Consumer Interface and the Provider Platform can perform offline negotiations on the payment terms. Once an agreement is reached, the Consumer Interface and Provider Platform can resume transactions.
DELETE /beckn/e-marketplace-bb/0.2/catalog/provider/{providerId}/{resource}/{id} HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
Successful fetch of resources from the catalog
{
"id": "text",
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"cancellation_terms": [
{
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"reason_required": true,
"cancel_by": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"cancellation_fee": {
"percentage": "text",
"amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
},
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"refund_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_eligible": true,
"refund_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"replacement_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"return_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_eligible": true,
"return_time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"rateable": true,
"rating": "text",
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
Find aggregator catalog of a specific resource
Name of the resource
ID of the Resource
Id of the provider
Unique reference ID to the fulfillment of an order
ID of the category
ID of the payment term that can be referred at an item or an order level in a catalog
Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.
Describes the catalog of a business.
Describes how a an order will be rendered/fulfilled to the end-customer
A label under which a collection of items can be grouped.
Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.
Describes the terms of settlement between the Consumer Interface and the Provider Platform for a single transaction. When instantiated, this object contains the amount that has to be settled,The payment destination destination detailsWhen the settlement should happen, andA transaction reference ID. During a transaction, the Provider Platform reserves the right to decide the terms of payment. However, the Consumer Interface can send its terms to the Provider Platform first. If the Provider Platform does not agree to those terms, it must overwrite the terms and return them to the Consumer Interface. If overridden, the Consumer Interface must either agree to the terms sent by the Provider Platform in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the Consumer Interface and the Provider Platform can perform offline negotiations on the payment terms. Once an agreement is reached, the Consumer Interface and Provider Platform can resume transactions.
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.
GET /beckn/e-marketplace-bb/0.2/catalog/{resource}/{id} HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
Successful fetch of resources from the catalog
{
"id": "text",
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"cancellation_terms": [
{
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"reason_required": true,
"cancel_by": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"cancellation_fee": {
"percentage": "text",
"amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
},
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"refund_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_eligible": true,
"refund_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"replacement_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"return_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_eligible": true,
"return_time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"rateable": true,
"rating": "text",
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
Consumer Interface declares the customer's intent to buy/avail products or services
Every API call in beckn protocol has a context. It provides a high-level overview to the receiver about the nature of the intended transaction. Typically, it is the Consumer Interface that sets the transaction context based on the consumer's location and action on their UI. But sometimes, during unsolicited callbacks, the Provider Platform also sets the transaction context but it is usually the same as the context of a previous full-cycle, request-callback interaction between the Consumer Interface and the Provider Platform. The context object contains four types of fields. Demographic information about the transaction using fields like domain
, country
, and region
.Addressing details like the sending and receiving platform's ID and API URL.Interoperability information like the protocol version that implemented by the sender and,Transaction details like the method being called at the receiver's endpoint, the transaction_id that represents an end-to-end user session at the Consumer Interface, a message ID to pair requests with callbacks, a timestamp to capture sending times, a ttl to specifiy the validity of the request, and a key to encrypt information if necessary. This object must be passed in every interaction between a Consumer Interface and a Provider Platform. In HTTP/S implementations, it is not necessary to send the context during the synchronous response. However, in asynchronous protocols, the context must be sent during all interactions,
POST /beckn/e-marketplace-bb/0.2/search HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 44620
{
"context": {
"domain": {},
"location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"action": "search",
"version": "text",
"bap_id": "text",
"bap_uri": "https://example.com",
"bpp_id": "text",
"bpp_uri": "https://example.com",
"transaction_id": "123e4567-e89b-12d3-a456-426614174000",
"message_id": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-04-24T07:40:44.542Z",
"key": "text",
"ttl": "text"
},
"message": {
"intent": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"provider": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"category_id": "text",
"rating": "text",
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"categories": [
{
"id": "text",
"parent_category_id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "text",
"type": "text",
"rateable": true,
"rating": "text",
"state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"tracking": true,
"customer": {
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-04-24",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"agent": {
"id": "text",
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-04-24",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"organization": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"rating": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"vehicle": {
"category": "text",
"capacity": 1,
"make": "text",
"model": "text",
"size": "text",
"variant": "text",
"color": "text",
"energy_type": "text",
"registration": "text",
"wheels_count": "text",
"cargo_volumne": "text",
"wheelchair_access": "text",
"code": "text",
"emission_standard": "text"
},
"stops": [
{
"id": "text",
"parent_stop_id": "text",
"location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"type": "text",
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"instructions": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-04-24",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"authorization": {
"type": "text",
"token": "text",
"valid_from": "2025-04-24T07:40:44.542Z",
"valid_to": "2025-04-24T07:40:44.542Z",
"status": "text"
}
}
],
"path": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
],
"payments": [
{
"id": "text",
"collected_by": null,
"url": "https://example.com",
"params": {
"transaction_id": "text",
"amount": "text",
"currency": "text",
"bank_code": "text",
"bank_account_number": "text",
"virtual_payment_address": "text",
"source_bank_code": "text",
"source_bank_account_number": "text",
"source_virtual_payment_address": "text"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
],
"locations": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
}
],
"offers": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"location_ids": [
"text"
],
"category_ids": [
"text"
],
"item_ids": [
"text"
],
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
],
"items": [
{
"id": "text",
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"cancellation_terms": [
{
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"reason_required": true,
"cancel_by": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"cancellation_fee": {
"percentage": "text",
"amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
},
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"refund_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_eligible": true,
"refund_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"replacement_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"return_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_eligible": true,
"return_time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"rateable": true,
"rating": "text",
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
],
"exp": "2025-04-24T07:40:44.542Z",
"rateable": true,
"ttl": 1,
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"fulfillment": {
"id": "text",
"type": "text",
"rateable": true,
"rating": "text",
"state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"tracking": true,
"customer": {
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-04-24",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"agent": {
"id": "text",
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-04-24",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"organization": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"rating": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"vehicle": {
"category": "text",
"capacity": 1,
"make": "text",
"model": "text",
"size": "text",
"variant": "text",
"color": "text",
"energy_type": "text",
"registration": "text",
"wheels_count": "text",
"cargo_volumne": "text",
"wheelchair_access": "text",
"code": "text",
"emission_standard": "text"
},
"stops": [
{
"id": "text",
"parent_stop_id": "text",
"location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"type": "text",
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"instructions": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-04-24",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"authorization": {
"type": "text",
"token": "text",
"valid_from": "2025-04-24T07:40:44.542Z",
"valid_to": "2025-04-24T07:40:44.542Z",
"status": "text"
}
}
],
"path": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"payment": {
"id": "text",
"collected_by": null,
"url": "https://example.com",
"params": {
"transaction_id": "text",
"amount": "text",
"currency": "text",
"bank_code": "text",
"bank_account_number": "text",
"virtual_payment_address": "text",
"source_bank_code": "text",
"source_bank_account_number": "text",
"source_virtual_payment_address": "text"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"category": {
"id": "text",
"parent_category_id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"offer": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"location_ids": [
"text"
],
"category_ids": [
"text"
],
"item_ids": [
"text"
],
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"item": {
"id": "text",
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"cancellation_terms": [
{
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"reason_required": true,
"cancel_by": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"cancellation_fee": {
"percentage": "text",
"amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
},
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"refund_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_eligible": true,
"refund_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"replacement_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"return_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_eligible": true,
"return_time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"rateable": true,
"rating": "text",
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
}
}
Acknowledgement of message received after successful validation of schema and signature
{
"message": {
"ack": {
"status": "ACK",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
},
"error": {
"code": "text",
"paths": "text",
"message": "text"
}
}
Add a resource to the catalog
Name of the resource
ID of the Resource
Describes the catalog of a business.
Describes how a an order will be rendered/fulfilled to the end-customer
A label under which a collection of items can be grouped.
Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.
Describes the terms of settlement between the Consumer Interface and the Provider Platform for a single transaction. When instantiated, this object contains the amount that has to be settled,The payment destination destination detailsWhen the settlement should happen, andA transaction reference ID. During a transaction, the Provider Platform reserves the right to decide the terms of payment. However, the Consumer Interface can send its terms to the Provider Platform first. If the Provider Platform does not agree to those terms, it must overwrite the terms and return them to the Consumer Interface. If overridden, the Consumer Interface must either agree to the terms sent by the Provider Platform in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the Consumer Interface and the Provider Platform can perform offline negotiations on the payment terms. Once an agreement is reached, the Consumer Interface and Provider Platform can resume transactions.
Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.
Describes the catalog of a business.
Describes how a an order will be rendered/fulfilled to the end-customer
A label under which a collection of items can be grouped.
Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.
Describes the terms of settlement between the Consumer Interface and the Provider Platform for a single transaction. When instantiated, this object contains the amount that has to be settled,The payment destination destination detailsWhen the settlement should happen, andA transaction reference ID. During a transaction, the Provider Platform reserves the right to decide the terms of payment. However, the Consumer Interface can send its terms to the Provider Platform first. If the Provider Platform does not agree to those terms, it must overwrite the terms and return them to the Consumer Interface. If overridden, the Consumer Interface must either agree to the terms sent by the Provider Platform in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the Consumer Interface and the Provider Platform can perform offline negotiations on the payment terms. Once an agreement is reached, the Consumer Interface and Provider Platform can resume transactions.
PUT /beckn/e-marketplace-bb/0.2/catalog/{resource}/{id} HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 22332
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"category_id": "text",
"rating": "text",
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"categories": [
{
"id": "text",
"parent_category_id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "text",
"type": "text",
"rateable": true,
"rating": "text",
"state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"tracking": true,
"customer": {
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-04-24",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"agent": {
"id": "text",
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-04-24",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"organization": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"rating": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"vehicle": {
"category": "text",
"capacity": 1,
"make": "text",
"model": "text",
"size": "text",
"variant": "text",
"color": "text",
"energy_type": "text",
"registration": "text",
"wheels_count": "text",
"cargo_volumne": "text",
"wheelchair_access": "text",
"code": "text",
"emission_standard": "text"
},
"stops": [
{
"id": "text",
"parent_stop_id": "text",
"location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"type": "text",
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"instructions": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-04-24",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"authorization": {
"type": "text",
"token": "text",
"valid_from": "2025-04-24T07:40:44.542Z",
"valid_to": "2025-04-24T07:40:44.542Z",
"status": "text"
}
}
],
"path": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
],
"payments": [
{
"id": "text",
"collected_by": null,
"url": "https://example.com",
"params": {
"transaction_id": "text",
"amount": "text",
"currency": "text",
"bank_code": "text",
"bank_account_number": "text",
"virtual_payment_address": "text",
"source_bank_code": "text",
"source_bank_account_number": "text",
"source_virtual_payment_address": "text"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
],
"locations": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
}
],
"offers": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"location_ids": [
"text"
],
"category_ids": [
"text"
],
"item_ids": [
"text"
],
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
],
"items": [
{
"id": "text",
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"cancellation_terms": [
{
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"reason_required": true,
"cancel_by": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"cancellation_fee": {
"percentage": "text",
"amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
},
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"refund_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_eligible": true,
"refund_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"replacement_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"return_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_eligible": true,
"return_time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"rateable": true,
"rating": "text",
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
],
"exp": "2025-04-24T07:40:44.542Z",
"rateable": true,
"ttl": 1,
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
Successful fetch of resources from the catalog
{
"id": "text",
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"cancellation_terms": [
{
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"reason_required": true,
"cancel_by": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"cancellation_fee": {
"percentage": "text",
"amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
},
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"refund_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_eligible": true,
"refund_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"replacement_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"return_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_eligible": true,
"return_time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"rateable": true,
"rating": "text",
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
Add a resource to the catalog
Name of the resource
Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.
Describes the catalog of a business.
Describes how a an order will be rendered/fulfilled to the end-customer
A label under which a collection of items can be grouped.
Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.
Describes the terms of settlement between the Consumer Interface and the Provider Platform for a single transaction. When instantiated, this object contains the amount that has to be settled,The payment destination destination detailsWhen the settlement should happen, andA transaction reference ID. During a transaction, the Provider Platform reserves the right to decide the terms of payment. However, the Consumer Interface can send its terms to the Provider Platform first. If the Provider Platform does not agree to those terms, it must overwrite the terms and return them to the Consumer Interface. If overridden, the Consumer Interface must either agree to the terms sent by the Provider Platform in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the Consumer Interface and the Provider Platform can perform offline negotiations on the payment terms. Once an agreement is reached, the Consumer Interface and Provider Platform can resume transactions.
Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.
Describes the catalog of a business.
Describes how a an order will be rendered/fulfilled to the end-customer
A label under which a collection of items can be grouped.
Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.
Describes the terms of settlement between the Consumer Interface and the Provider Platform for a single transaction. When instantiated, this object contains the amount that has to be settled,The payment destination destination detailsWhen the settlement should happen, andA transaction reference ID. During a transaction, the Provider Platform reserves the right to decide the terms of payment. However, the Consumer Interface can send its terms to the Provider Platform first. If the Provider Platform does not agree to those terms, it must overwrite the terms and return them to the Consumer Interface. If overridden, the Consumer Interface must either agree to the terms sent by the Provider Platform in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the Consumer Interface and the Provider Platform can perform offline negotiations on the payment terms. Once an agreement is reached, the Consumer Interface and Provider Platform can resume transactions.
POST /beckn/e-marketplace-bb/0.2/catalog/{resource} HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 8971
{
"id": "text",
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"cancellation_terms": [
{
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"reason_required": true,
"cancel_by": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"cancellation_fee": {
"percentage": "text",
"amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
},
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"refund_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_eligible": true,
"refund_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"replacement_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"return_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_eligible": true,
"return_time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"rateable": true,
"rating": "text",
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
Successful fetch of resources from the catalog
{
"id": "text",
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"cancellation_terms": [
{
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"reason_required": true,
"cancel_by": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"cancellation_fee": {
"percentage": "text",
"amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
},
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"refund_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_eligible": true,
"refund_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"replacement_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"return_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_eligible": true,
"return_time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"rateable": true,
"rating": "text",
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
Update a resource in the provider's catalog
Id of the provider
Name of the resource
ID of the resource in the provider's catalog
Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.
Describes the catalog of a business.
Describes how a an order will be rendered/fulfilled to the end-customer
A label under which a collection of items can be grouped.
Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.
Describes the terms of settlement between the Consumer Interface and the Provider Platform for a single transaction. When instantiated, this object contains the amount that has to be settled,The payment destination destination detailsWhen the settlement should happen, andA transaction reference ID. During a transaction, the Provider Platform reserves the right to decide the terms of payment. However, the Consumer Interface can send its terms to the Provider Platform first. If the Provider Platform does not agree to those terms, it must overwrite the terms and return them to the Consumer Interface. If overridden, the Consumer Interface must either agree to the terms sent by the Provider Platform in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the Consumer Interface and the Provider Platform can perform offline negotiations on the payment terms. Once an agreement is reached, the Consumer Interface and Provider Platform can resume transactions.
Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.
Describes the catalog of a business.
Describes how a an order will be rendered/fulfilled to the end-customer
A label under which a collection of items can be grouped.
Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.
Describes the terms of settlement between the Consumer Interface and the Provider Platform for a single transaction. When instantiated, this object contains the amount that has to be settled,The payment destination destination detailsWhen the settlement should happen, andA transaction reference ID. During a transaction, the Provider Platform reserves the right to decide the terms of payment. However, the Consumer Interface can send its terms to the Provider Platform first. If the Provider Platform does not agree to those terms, it must overwrite the terms and return them to the Consumer Interface. If overridden, the Consumer Interface must either agree to the terms sent by the Provider Platform in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the Consumer Interface and the Provider Platform can perform offline negotiations on the payment terms. Once an agreement is reached, the Consumer Interface and Provider Platform can resume transactions.
PUT /beckn/e-marketplace-bb/0.2/catalog/provider/{providerId}/{resource}/{id} HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 8971
{
"id": "text",
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"cancellation_terms": [
{
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"reason_required": true,
"cancel_by": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"cancellation_fee": {
"percentage": "text",
"amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
},
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"refund_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_eligible": true,
"refund_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"replacement_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"return_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_eligible": true,
"return_time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"rateable": true,
"rating": "text",
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
Successful fetch of resources from the catalog
{
"id": "text",
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"cancellation_terms": [
{
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"reason_required": true,
"cancel_by": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"cancellation_fee": {
"percentage": "text",
"amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
},
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"refund_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_eligible": true,
"refund_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"replacement_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"return_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_eligible": true,
"return_time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"rateable": true,
"rating": "text",
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
Add a resource to the catalog
Name of the resource
Id of the provider
Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.
The physical location of something
Describes how a an order will be rendered/fulfilled to the end-customer
A label under which a collection of items can be grouped.
Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.
Describes the terms of settlement between the Consumer Interface and the Provider Platform for a single transaction. When instantiated, this object contains the amount that has to be settled,The payment destination destination detailsWhen the settlement should happen, andA transaction reference ID. During a transaction, the Provider Platform reserves the right to decide the terms of payment. However, the Consumer Interface can send its terms to the Provider Platform first. If the Provider Platform does not agree to those terms, it must overwrite the terms and return them to the Consumer Interface. If overridden, the Consumer Interface must either agree to the terms sent by the Provider Platform in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the Consumer Interface and the Provider Platform can perform offline negotiations on the payment terms. Once an agreement is reached, the Consumer Interface and Provider Platform can resume transactions.
Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.
The physical location of something
Describes how a an order will be rendered/fulfilled to the end-customer
A label under which a collection of items can be grouped.
Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.
Describes the terms of settlement between the Consumer Interface and the Provider Platform for a single transaction. When instantiated, this object contains the amount that has to be settled,The payment destination destination detailsWhen the settlement should happen, andA transaction reference ID. During a transaction, the Provider Platform reserves the right to decide the terms of payment. However, the Consumer Interface can send its terms to the Provider Platform first. If the Provider Platform does not agree to those terms, it must overwrite the terms and return them to the Consumer Interface. If overridden, the Consumer Interface must either agree to the terms sent by the Provider Platform in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the Consumer Interface and the Provider Platform can perform offline negotiations on the payment terms. Once an agreement is reached, the Consumer Interface and Provider Platform can resume transactions.
PUT /beckn/e-marketplace-bb/0.2/catalog/provider/{providerId}/{resource} HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 8971
{
"id": "text",
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"cancellation_terms": [
{
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"reason_required": true,
"cancel_by": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"cancellation_fee": {
"percentage": "text",
"amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
},
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"refund_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_eligible": true,
"refund_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"replacement_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"return_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_eligible": true,
"return_time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"rateable": true,
"rating": "text",
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}
Successful fetch of resources from the catalog
{
"id": "text",
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"quantity": {
"allocated": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"available": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"maximum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"minimum": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"selected": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"unitized": {
"count": 1,
"measure": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
}
},
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"price": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"cancellation_terms": [
{
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-04-24T07:40:44.542Z",
"updated_by": "text"
},
"reason_required": true,
"cancel_by": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"cancellation_fee": {
"percentage": "text",
"amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
},
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"refund_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_eligible": true,
"refund_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
}
}
],
"replacement_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
}
],
"return_terms": [
{
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_eligible": true,
"return_time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": {
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
},
"time": {
"label": "text",
"timestamp": "2025-04-24T07:40:44.542Z",
"duration": "text",
"range": {
"start": "2025-04-24T07:40:44.542Z",
"end": "2025-04-24T07:40:44.542Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-04-24T07:40:44.542Z"
],
"times": [
"2025-04-24T07:40:44.542Z"
]
}
},
"rateable": true,
"rating": "text",
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}